Quick Start
Quick Start Guide
This guide will walk you through the process of setting up a minimal development environment using the Euclid Development Environment project, installing the Metagraph Framework, and launching clusters. The process should take less than an hour, including installing dependencies.
Install Dependencies
Install Basic Dependencies
Many developers can skip this step because these dependencies are already installed.
Install argc
Install Giter
Configure Docker
The Euclid Development Environment starts up to 10 individual docker containers to create a minimal development environment which takes some significant system resources. Configure docker to make at least 8GB of RAM available. If you are using Docker Desktop, this setting can be found under Preferences -> Resources.
Create a Github Access Token
See instructions for how to create an access token. The token only needs read:packages
scope. Save this token for later, it will be added as an environment variable.
Install
Clone
Clone the Euclid Development Environment project to your local machine.
See the Development Environment section for an overview of the directory structure of the project.
Configure
Edit the github_token
variable within the euclid.json
file with your Github Access Token generated previously. Update the project_name
field to the name of your project.
Hydra
Familiarize yourself with the hydra
CLI. We can use the hydra
CLI tool to build the necessary docker containers and manage our network clusters.
Install Project
Running the install
command will do two things:
Creates currency-l0 and currency-l1 projects from a g8 template and moves them to the
source/project
directory.Detach your project from the source repo.
Detaching your project from the source repo removes its remote git configuration and prepares your project to be included in your own version control. Once detached, your project can be updated with hydra
.
You can import a metagraph template from custom examples by using the following command:
By default, we use the Metagraph Examples repository. You should provide the template name when running this command. To list the templates available to install, type:
Build
Build your network clusters with hydra. By default, this builds metagraph-ubuntu
, metagraph-base-image
, and prometheus
+ grafana
monitoring containers. These images will allow deploy the containers with metagraph layers: global-l0
, metagraph-l0
, currency-l1
, and data-l1
. The dag-l1
layer is not built by default since it isn't strictly necessary for metagraph development. You can include it on the euclid.json
file.
Start the build process. This can take a significant amount of time... be patient.
Run
After your containers are built, go ahead and start them with the start-genesis
command. This starts all network components from a fresh genesis snapshot.
Once the process is complete you should see output like this:
You can also check the status of your containers with the status
command.
Next Steps
You now have a minimal development environment installed and running 🎉
Last updated
Was this helpful?