A progressive Node.js framework for building efficient and scalable server-side applications.

Description

Nest framework TypeScript starter repository.

Installation

$ npm install

.env

Create .env file in the root directory of the project. .env file should include these properties:

MONGO_CONNECTION_STRING=XXX
MONGO_DATABASE_NAME=XXX

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Docker

In order to use Docker container, you should provide same .env properties.

# create .env file and define variables.
$ touch .env.docker

# run
$ docker-compose up

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

API Documentation

Swagger API documentation is available on http://localhost:3000/api route.

ToDo

• More Detailed Swagger Documentation
• Unit Test
• Integration Test
• E2E Test
• Dockerize
• Front-end??

Support

Nest is an MIT-licensed open source project. It can grow thanks to the sponsors and support by the amazing backers. If you'd like to join them, please read more here.

License

Nest is MIT licensed.