Skip to content

Latest commit

 

History

History
46 lines (32 loc) · 1.59 KB

README.md

File metadata and controls

46 lines (32 loc) · 1.59 KB

A Docker enabled Nodejs/Typescript MongoDB REST API

A project to create a Docker enabled Nodejs/Typescript MongoDB REST API which can act as a boilerplate/template.

The project follows REST Principles and Folder structure alongwith some basic Tests.

Quick Start Guide

To run the cloned codebase directly, you need to have Node.js and Docker installed.

  1. Run npm i to install dependencies.
  2. Run sudo docker-compose up -d to get a MongoDB instance running.
  3. Make your own .env file in the project root, following the key name but not value used in .env.example.
  4. From there, any the following should work:
  • npm run test
  • npm run test-debug
  • npm start
  • npm run debug

For linux/mac users, replace the scripts of the package.json file with the following:

"scripts": {
  "start": "tsc && node --unhandled-rejections=strict ./dist/app.js",
  "debug": "export DEBUG=* && npm start",
  "test": "mocha -r ts-node/register 'test/**/*.test.ts' --unhandled-rejections=strict",
  "test-debug": "export DEBUG=* && npm test"
},

To-do

  1. Create Dockerfile to Contain the REST API in a Docker container.
  2. Create separate databases for test and debug cases.
  3. Allow patch requests in test but not in development.
  4. Write documentation for the APIs.

Built with: