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

Description

Nest framework TypeScript starter repository.

Installation

$ yarn

Environments

#DATABASE_URL
DATABASE_URL=

## LOCAL DB
 PG_HOST=
 PG_PORT=
 PG_USER=
 PG_PASSWORD=
 PG_DATABASE=


### GLOBALS
PORT=
MODE=

# migrations
# RUN_MIGRATIONS

#REDIS
REDIS_HOST=
REDIS_PORT=

# secret
JWT_SECRET=


# mail
SG_MAIL_HOST=
SG_MAIL_USER=
SG_MAIL_PASSWORD=
SG_MAIL_FROM=
SG_MAIL_PORT=

# GOOGLE

GOOGLE_CLIENT_ID=
GOOGLE_SECRET=
GOOGLE_CALLBACK_URL=


# INSTAGRAM
INSTAGRAM_ACCESS_TOKEN=
INSTAGRAM_BASE_URL=

#API
API_URL=
API_BASE_URL=

# Cloudinary
CLOUD_NAME=
CLOUD_KEY=
CLOUD_SECRET=

Prepare hooks

Install husky

$ yarn run prepare

Generate hook pre-commit

$ npx husky add .husky/pre-commit 'yarn lint-staged'

Generate hook commit-msg

$ npx husky add .husky/commit-msg  'npx --no -- commitlint --edit ${1}'

Running the app

# development
$ yarn run start

# watch mode
$ yarn run start:dev

# production mode
$ yarn run start:prod

Test

# unit tests
$ yarn run test

# e2e tests
$ yarn run test:e2e

# test coverage
$ yarn 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.