Restaurant Rest API

Sample Rest api of restaurant written in Javascript using Nestjs & mongoose

Configuration

See .env_example file for configuration

Installation

$ npm install

Running the app

create `.env` file in root and copy content from `.env_example` and configure values.

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# tests
$ npm test

API Documentation

Import open api docs into postman as collection.

  docs/restaurant-api-v0.1.yaml

Directory Structure

├── docs
|  ├── README.md
|  └── restaurant-api-v0.1.yaml
├── index.js
├── nest-cli.json
├── nodemon.json
├── package-lock.json
├── package.json
├── README.md
└── src
   ├── controllers
   |  ├── index.js
   |  ├── restaurant-menu.controller.js
   |  ├── restaurant-munu.controller.spec.js
   |  ├── restaurant.controller.js
   |  └── restaurant.controller.spec.js
   ├── filters
   |  └── exception.filter.js
   ├── gateway.module.js
   ├── main.js
   ├── middlewares
   |  ├── index.js
   |  └── logger.middleware.js
   ├── modules
   |  ├── database.module.js
   |  └── index.js
   ├── schemas
   |  ├── index.js
   |  ├── restaurant-menu.schema.js
   |  └── restaurant.schema.js
   └── services
      ├── index.js
      ├── restaurant-menu.service.js
      ├── restaurant-menu.service.spec.js
      ├── restaurant.service.js
      └── restaurant.service.spec.js

Tech Stack

• Node.js
• Nest.js (Javascript)
• Mongoose (MongoDb)
• Winston (Logging)

Next Steps

• Add validation for input
• Add Auth guards using JWT
• Make docs downloadable
• Add tests