NestJS MongoDB Boilerplate

The boilerplate repo for most of the enterprise projects. We are using NestJS with Keycloak, DigitalOcean & Cloudflare services to create robust enterprise applications. Thus this boilerplate serve as the basis for initializing such projects.

Description

This repository is built on top of NestJS framework TypeScript starter repository. https://github.com/nestjs/nest

Basic Coverage

• Emailing with Nodemailer
• Email validation with deep-email-validator and Zerobounce
• Minimal email templating with HandlerbarJS
• SMTP Integration
• Media & file management with Digital Ocean Spaces / S3 buckets
• Basic MongoDB with Mongoose
• Keycloak authentication
• MongoDB, Redis and/or Memory Caching
• Dockerfile for deployment
• Puppeteer for html-to-pdf

Before Starting

1. Clone the repo
2. Remove the .git folder and git init with relevant steps
3. Set up env variables from .example.env
4. Setup SSLs, basic instruction in ssl/README.md

Installation

$ npm install

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, and so is this repository.

Stay in touch

• Author - Atyantik Technologies
• NestJS Website - https://nestjs.com
• Twitter - @atyantik_tech

License

MIT licensed.