README.md

NestJS Starter Boilerplate

Features:
✅ Basic Authentication
📚 Swagger API Documentation
🐳 Containerized with Docker
☸️ Kubernetes Configuration
🧪 Testing Setup

Installation

$ yarn

Running Server

# development
$ yarn dev

# production
$ yarn start

Running all services on Docker

docker-compose up --build

Run only database and redis services on Docker

docker-compose up postgres redis

Build

yarn build

Tests

# unit tests
$ yarn test

Swagger Documentation

• Swagger documentation endpoint will be running at /docs .

K8s Deployment Local

# first start minikube
minikube start

# deployment
kubectl apply -f k8s/

# get endpoint of k8s cluster
minikube service nestjs-starter-service

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.

Author

🇮🇳 Harsh Makwana
Github Linkedin Instagram