This repo has the goal to create a clean REST API for the BJS with all needed things (user management, database, ...)
- The API must be well documented in order to make development for other projects smoothly
- In order to prevent bugs and errors the application must rely on automated (unit) tests
In order to start developing and running the api locally (and not within docker-compose) you will need a running (postgres) database. There are a few options to run a database, but it is recommended to use a postgres database with docker.
Therefore this project has a docker-compose file just for a database (docker-compose.db.yml).
To startup the database run
docker-compose -f docker-compose.db.yml up -d
The api can be found on port 8080 of localhost.
It is also possible to run the complete api in docker. To run the complete api run
docker-compose -f docker-compose.dev.yml up
The api can be found on port 8080 of localhost.
Look here.