Development

Our first goal during this project was to make a great and easy accesible dev env. You can setup the whole backend with the database in just 3 commands, and here is how!

Install all the required packages

You will install all packages that are needed to run out application by entering this command:

yarn

Setting up your database

We will make use of Postgresql as our database. It will run on a Docker container with this command:

yarn services:up

Migrating all the models

After running the docker container our database will have no tables. To make sure we have all the models that we've defined in the Prisma file we need to execure this command:

yarn run migrate

Adding all the environement variables

We've made two env.example files in the project. You'll need to copy them in the same folder and rename then to .env, so all the env var checks are met.

Running the API

The application can be run with:

yarn run dev:api