NestJS Monolithic template

About The App

Nest framework TypeScript TypeORM Postgres Monolithic starter repository.

Quick scaffolding

Create modules, services, controller - right from the CLI!

Instant feedback

Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes are reflected instantaneously.

JWT Authentication

Installed and configured JWT authentication.

Next generation Typescript

Always up to date typescript version.

Industry-standard routing

It's natural to want to add pages (e.g. /about`) to your application, and routing makes this possible.

Environment Configuration

development, staging and production environment configurations

Swagger Api Documentation

Already integrated API documentation. To see all available endpoints visit http://localhost:3000/api/documentation

Linter

tslint + eslint + prettier = ❤️

---

Getting started

# 1. Clone the repository.
git clone https://github.com/Rapid-learnings/nestjs-template

# 2. Enter your newly-cloned folder.
cd nestjs-template

# 3. Install dependencies. (Make sure yarn is installed: https://yarnpkg.com/lang/en/docs/install)
yarn install

# 4. Run development server and open http://localhost:3000
yarn start:dev

Starting Docker container

# Run below command inside nestjs-template folder in terminal
PORT=3000 docker-compose up

---

Test

# unit tests
$ yarn test

# e2e tests
$ yarn test:e2e

# test coverage
$ yarn test:cov

---

Swagger documentation

After running the app, navigate to the path http://localhost:3000/api/documentation to view swagger UI

Add Envioroment variables

Please refer .env.example for the env variables that is needed

---

Database Migrations

Generate migration from database yarn migration:generate initialMigration

Run migrations yarn migration:run

---

License

Nest is MIT licensed.

nestjs_template