Elements in Five Minutes or Less

Get started with the all-in-one server engine Elements in less than five minutes for your connected app or game.

From a development perspective, it's easy to set up a local instance of Elements. Elements runs in Docker. Using the predefined docker-compose.yaml, it's possible to run a fully operational instance that closely resembles cloud deployment. With this configuration, you can easily develop without the need to deploy or interfere with a live instance, while working independently from other developers on your team.

Prerequisites

Unless otherwise specified, earlier versions of supporting software are very likely to work. However, the versions listed in this section have the most extensive test coverage.

1. Docker Version 24.0.2, or Greater

2. Git 2.25.1 or greater for using Cloud Functions.

Running Locally

Docker manages the installation and setup of further prerequisites including MongoDB, Redis, and the variety of services which locally reproduces the configuration similar to all hosted versions of Elements. The Docker based distribution on Github always contains the most up-to-date details. Refer to the Readme for the step-by-step process.

The steps to run Elements are as follows:

1. Obtain a Community Edition (CE) License - https://getelements.dev/get-elements

2. Follow the Instructions in our Github Repo - https://github.com/Elemental-Computing/docker-compose/

Accessing Documentation

Each instance of Elements provides a copy of the documentation specific to the release. It also provides Swagger json files which you can access. The documentation will vary based on the version.