A Rest API for point of interest (POI) locations.
This project is currently using:
- NodeJS 16.14.2
- npm 8.6.0
- Express 4.18.8
- Docker 20.10.14
- MongoDB 5.0.8
- Mongoose 6.3.1
- Jest 28.0.1
- ESLint 8.2.0
To install the project, run
docker-compose build
⚙️ This project uses a local MongoDB running in Docker. It is using a mongoimport to seed the Database with initial values from places.json.
The, to run the project, run
docker-compose up
✔️ Done, now you'll be able to use the API using the Swagger UI at http://localhost:3000.
To run the automated unit tests, run
npm test
All services and controllers should be fully tested.
🤖 This project also uses Github Actions to test it everytime a commit is pushed.
🚀 Please refer to API Documentation.
To auto-generate the API documentation (that is used by Swagger), run
npm run docs