The best way to get a database for development is to use docker
Navigate to the api directory cd api
Run make start-deps
to start the container
optional
Run make start-pg-shell
to access the postgres shell or
Download any database console or explorer to access the database data. We recommend dbeaver
To stop the running containers and server, run make stop-deps
Run make reset-deps
to restart all containers.
cd api
cp .env.example .env
yarn install
to install all dependenciesJWT_SECRET
in your .env file(e.g. const secret = require('crypto').randomBytes(64).toString('hex')
)
Run make init
to initialize and start the api service. This will run migrations, seed the database and start the server.
You only need run make init
the first time. Subsequent run only requires make run
or yarn dev
http://localhost:8080/api/docs