Welcome aboard! In this doc you will be provided with all the relevant knowledge to set up the backend services locally.
A few software tools are required to set the backend services:
- docker (installation instructions).
- NodeJS 20. (we strongly suggest using nvm).
- pnpm is used as package manager, so be sure you have it globally installed.
- Clone this repo
git clone https://github.com/notaphplover/one-game.git
- Go to the root package
cd one-game
- Install dependencies
pnpm i
-
Generate
.envfiles. Some packages require certain env variables to work properly. On a local setup,.envfiles are read to propagate them. For now, those packages arebackend-dev-proxy,backend-dev-game-db,backend-dev-user-db,backend-service-game,backend-service-gatewayandbackend-service-user. In each of those folders you can find an.env.examplefile which has a valid local configuration. You can generate the.envfile simply copying the.env.examplefile. -
Run migrations
pnpm run migrations:run
Don't worry, build tasks are cached through turbo.
- Generate a certificate to be used by the dev proxy server.
To accomplish that, go to packages/backend/tools/backend-dev-proxy and run the following command:
mkdir ssl && \
openssl req -x509 -newkey rsa:4096 -keyout ssl/localhost.key.pem -out ssl/localhost.cert.pem -sha256 -days 3650 -nodes -subj "/CN=Dev proxy certificate"
- Launch services. On the root folder of the monorepo, launch the
servescript:
pnpm run serve
You might be interested in just running the HTTP REST API services. In that case, launch the serve:api:rest script:
pnpm run serve:api:rest
That's all! You are ready to start calling the API
Sometimes a database is not properly created. Trying to launch the servers with no env variables is a way to do this. Reseting the db is probably the easiest way to go, at least in a local setup.
Db state is saved on local volumes. Deleting the db container is not enough to reset the db state. Only after killing the container, removing it and removing its volume the db state is reset.