Benford's law stock API using Nestjs.
- NodeJS
- Git
- Docker
A few things to note in the project:
- Github Actions Workflows - Pre-configured Github Actions to run automated builds and publish image to Github Packages
- Dockerfile - Dockerfile to generate docker builds.
- Docker-compose - Docker compose script to build and start container.
- OpenAPI 3.0 Spec - A starter template to get started with API documentation using OpenAPI 3.0. This API spec is also available when running the development server at
http://localhost:3000/swagger-api
- .env file for configuration - Change server config like app port, mongo url etc
- Jest - Using Jest for running test cases
- Clone the repo
cd /modusbox-test && npm install
Create .env
files and add the relevant values for the variables.
Note: Find used env vars in .sample-env
npm start
Running the above commands results in
- 🌏API Server running at
http://localhost:3000
- ⚙️Swagger UI at
http://localhost:3000/swagger-api
docker-compose build
docker-compose up
Deployment is automated with Github Actions and deployed on heroku
https://modusbox.herokuapp.com/
npm run test
npm run test:e2e
npm run test:cov