Medium start
The medium start aims for contributions. It helps getting the project running locally while having the control to modify the codebase.
ℹ️
This guide assumes you have Docker (opens in a new tab). We'll use it to start a Postgres (opens in a new tab) and Redis (opens in a new tab) instances.
Step by step
Get the project from Github
$ git clone https://github.com/progressively-crew/progressively && cd progressivelyPrepare env variables
Copy the example env variable into real env variable (feel free to modify them).
$ cp ./websites/backend/.env.example ./websites/backend/.env
$ cp ./websites/frontend/.env.example ./websites/frontend/.envRun Postgres locally in Docker
You can choose to install it directly if you prefer in their website (opens in a new tab).
$ docker run --name progressively-db -e POSTGRES_PASSWORD=admin -e POSTGRES_USER=admin -e POSTGRES_DB=progressively -p 5432:5432 -d postgresRun Redis locally in Docker
You can choose to install it directly if you prefer in their website (opens in a new tab).
$ docker run -it --rm --name progressively-redis -p 6379:6379 -d redisSetup the monorepo
Install dependencies, link workspaces, prepare the Database table structure and build the SDKs. It's a one-off command.
$ pnpm run setup && pnpm run build && pnpm run db:prepareStart the project in dev mode
$ pnpm run dev