API Boilerplate Nestjs

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

Description

Nest framework TypeScript starter repository.

Installation

1. Install Node.JS LTS version
2. Install PostgreSQL
3. Clone this repository and enter on the respective folder
4. Install dependencies running:

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Create Migration

# Run migrations
$ npm run db:migrate

# Revert migrations
$ npm run db:rollback

Run Migrations Manually

$ npx typeorm migration:create -n NameMigration -d src/migrations

Generates models for TypeORM from existing databases

$ npx typeorm-model-generator -h localhost -d tempdb -u sa -x !Passw0rd -e postgres -o ./typegen -p 3306

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Documentation SWAGGER

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

# access documentation url
http://localhost:3000/api/

Directory Structure

├── /src
|   ├── /controllers
|   ├── /database
|   |    ├── /migrations
|   |    
|   ├── /helpers
|   ├── /middleware
|   ├── /models
|   ├── /services
|   ├── /validators
|   ├── /interfaces
|
├── /test

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.