The Makefile is in beta and may not work for your case. At the moment we recommend following the guide in new engineer welcome, but you can use the make file for reference.
As part of the overall New Engineer Welcome you setup the OS, virtual envs and dependences and then run the services "Running the Services" section. The beta makefile is one option to make certain aspects of this easier and more automatic.
- OS Setup not included
- .env file setup not included
- Assumptions on OS being used
- Assumptions on how services are being run, e.g. what is in docker or not.
- Assumptions on starting (optional) Minio
- Other risks related to limitations of this beta automation
We welcome contributions on improving Makefile and Makefile docs
A full development environment consists of 7 services running:
- Default Service
- Walrus Service
- Frontend Service
- MinIO / Cloud Storage Account
In this guide you will learn how to set up each service individually.
- Can run
Makefileson your local machine. This will help automate most of the processes. Otherwise you might need to inspect the makefile and run the command manually.
python3installed on your local machine. Version Used is :
docker composeinstalled https://docs.docker.com/compose/install/
yarnhttps://classic.yarnpkg.com/lang/en/docs/install/#debian-stable installed and Node version
To get started, clone the Diffgram repository
git clone https://github.com/diffgram/diffgram.git cd diffgram
Once you clone the repository and go to the main folder you can start setting up dependencies and services.
If you want to cleanup the environment to start from scratch run:
To setup a your dev environment variables and secrets, as well as your
virtualenv and python dependencies run:
If you get a permissions denied error make sure you have permissions over the directory you are creating the virtualenv. You can grant access by running the
chown command on the directory for the diffgram repo.
You need an instance of
postgres, rabbitmq and minio to be able to run diffgram. You can install those services manually or you can use the below utility command to spin them up from our default docker compose file.
The following sections will assume that you are running each command on a different terminal. We will prepend the prefix (T1, T2,T3,T4) to indicate which terminal you should be working on
Make sure that you have installed Python 3.11 on your system and that your
python3 executables are available on your shell. If the names of the executable are
python without the
3 you can change the following variables on the Makefile to:
Updated about 2 months ago