Check the API docs.
Make sure you check the migration module if you want to set this app on an existing postgres server.
All the dependencies for running the API as defined on this projects docker-compose.yml file.
To bring up a local instance of the API, you just need to run.
this will start dependencies on docker and the server locally using nodemon.
For continuous testing run:
To start the db, run and other dependencies run:
Default environment variables will be taken from .env
With the server started you can enter the following URL:
And will have the json object returned:
Run the command
npm test or
make test or if you want to use docker
make test-docker or
If you want to contribute, create your branch and place a PR or open an issue.