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

Description

Nest framework TypeScript starter repository.

Development

• Copy .env.example as .env:

  $ cp .env.example .env

Docker

• You need Docker installed to run the project locally.

• Docker compose will create a container for Postgresql database, PGAdmin (Web UI for Postgresql) and the NestJS Api.

  $ docker-compose build

• First time you will need to run the migrations in order to create the database and its schema. Also pgadmin won't work.

  $ yarn migration:run

• Then you can run it and being able to access localhost:3000 and localhost:8080

  $ yarn start:docker

  • localhost:3000 NestJS API.
  • localhost:5432 postgresql
  • localhost:8080 pgadmin, using user and password that you have in .env file.

PGAdmin

Accessing to pgadmin, first time, you need to add a new server using the data on your .env file

Local

Remember that the app needs a postgresql instance to run correctly.

• Install dependencies:

  $ yarn install

• Run migrations:

  $ yarn migration:run

• Execute app:

  $ yarn start:dev

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

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.

Stay in touch

• Author - Kamil Myśliwiec
• Website - https://nestjs.com
• Twitter - @nestframework

License

Nest is MIT licensed.