README.md

techgames-challenge-api

Requirements

• Docker
• Docker-Compose
• NVM (optional but highly recommended)
• Node (preferably v11.13.0)

Instructions

• To install dependencies (not needed for running server but helps with development)

npm install

• To run a dev server:

npm start

• To run the tests:

npm run test

• To run linter:

npm run lint

API Documentation

After running the dev server, docs will be at http://localhost:3000/api-docs