There are a lot of magic here 🪄
You have to assume that this repo will grown in a near future and will should be (almost) production-ready. Feel free to modify/add/delete files, folders, packages, endpoints, functions, classes... Whatever you want 😀
- NodeJS (+v16): https://nodejs.org/es/download/
The doc folder contains the Swagger specification for the project.
To configure the server create a file called .env based on file dotenv.template with following configuration:
| Environment variable | Type | Description |
|---|---|---|
| SERVER_PORT | string or number | Server exposed port (default: 8000) |
First, install node dependencies by running:
npm install
Run local development server by using following command, this will start a server in configured port.
npm run serve
Jest test can be run by using following command:
npm test
This project uses Eslint and Prettier for both code linting and format. These tools can be used with following commands:
# Check code lint
npm run lint
# Check code format
npm run check:format
# Fix code format
npm run format