Skip to content
Node.js Restful API starter template
TypeScript JavaScript
Branch: master
Clone or download

README.md

node-fastify-mongo-api

Node.js Restful API starter template with TypeScript, Fastify, MongoDB, Jest and Swagger.

Build Status Coverage Status

Requirements

  1. Node.js >= 10
  2. Docker

Getting started

  1. Install packages:
    npm install
  2. Run project:
    npm run start:dev
  3. Run ESLint with Prettier for static analysis and applying consistent code formatting:
    npm run lint

Testing

Using Jest for endpoint integration testing and swapping MongoDB with in memory mongo server. Code coverage report generated and consumed by Coveralls.

  1. Run tests with coverage:
    npm test

Documentation

Using Swagger for the endpoints documentation. Swagger UI available at http://localhost:3000/documentation.
Additional Postman collection attached to repository.

You can’t perform that action at this time.