Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 2.18 KB

README.md

File metadata and controls

86 lines (66 loc) · 2.18 KB
Raw

Nestjs rest API

nest-mongodb uses Typescript, Node.js and MongoDB.

Quick Start

The quickest way to get started with nest-mongodb server use github repository and clone as shown below:

# clone repository
$ git clone https://github.com/AlxPatidar/nest-mongodb.git server
# change directory to server folder
$ cd server

Installation

Install dependencies and devDependencies:

$ yarn install / npm install

Configuration

Configuration environment and change basic credentials:

$ cp .env.example .env

Start Server

Start the nest server:

$ yarn start / npm start

Start the nest development server:

$ yarn start:dev / npm start:dev

View the welcome page at: http://localhost:4001

Run Test

# Basic configuration test
$ yarn run test / yarn run test

Features

  • Language - TypeScript
  • REST API
  • Prettier
  • Focus on high performance
  • TsLint
  • Circle CI
  • Docker
  • Validation - class-validator and class-transformer

Useful npm/yarn commands

  • yarn build - Transpile TypeScript code
  • yarn start - Run application
  • yarn start:dev - Run application in development mode
  • yarn run format - Formate code with pritter
  • yarn run lint - Run for typescript linting
  • yarn run test - Run for test
  • yarn run test:watch - Run for test with watch

Docs & Community

  • #Nest for node js framework
  • #MongoDB for Official Database management
  • #Jest for Official testing tools
  • #Docker for container management
  • #Yarn for Official package manager
  • #CodeEditor Official text editor
  • #StackOverflow thanks for helping and provide solution on every problem

Stay in touch

License

Nest is MIT licensed.