Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tranphuquy19/nestjs-ejs-mvc-boilerplate

My MRE project - built-in many features! NestJS framework
https://github.com/tranphuquy19/nestjs-ejs-mvc-boilerplate

docker k8s nest nestjs nodejs postgresql security typeorm typescript

Last synced: 4 days ago
JSON representation

My MRE project - built-in many features! NestJS framework

Host: GitHub
URL: https://github.com/tranphuquy19/nestjs-ejs-mvc-boilerplate
Owner: tranphuquy19
Created: 2021-06-06T15:34:40.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-11-19T01:06:21.000Z (about 2 months ago)
Last Synced: 2024-12-25T14:05:42.357Z (11 days ago)
Topics: docker, k8s, nest, nestjs, nodejs, postgresql, security, typeorm, typescript
Language: TypeScript
Homepage:
Size: 4.37 MB
Stars: 60
Watchers: 2
Forks: 21
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml

Awesome Lists containing this project

README

        


  



[circleci-image]: https://img.shields.io/circleci/build/github/nestjs/nest/master?token=abc123def456

[circleci-url]: https://circleci.com/gh/nestjs/nest

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

    

















  

    

  



  

## Project badges

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=tranphuquy19_NestJS-EJS-MVC-boilerplate&metric=alert_status)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate) [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=tranphuquy19_NestJS-EJS-MVC-boilerplate&metric=sqale_rating)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate) [![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=tranphuquy19_NestJS-EJS-MVC-boilerplate&metric=security_rating)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate) [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=tranphuquy19_NestJS-EJS-MVC-boilerplate&metric=bugs)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate) [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=tranphuquy19_NestJS-EJS-MVC-boilerplate&metric=vulnerabilities)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate) [![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=tranphuquy19_NestJS-EJS-MVC-boilerplate&metric=code_smells)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate) [![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=tranphuquy19_NestJS-EJS-MVC-boilerplate&metric=sqale_index)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate) [![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=tranphuquy19_NestJS-EJS-MVC-boilerplate&metric=ncloc)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate)

[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/dashboard?id=tranphuquy19_NestJS-EJS-MVC-boilerplate)

## Description

[Nest](https://github.com/nestjs/nest) framework TypeScript starter repository.

_Notice: This project is designed to work with both the Web MVC model and the REST architecture. With many features needed for a #RealWorld project_

> ⚠️ **DISCLAIMER**: This project is still in development and not stable yet. It's not recommended to use it in production.

## Get started

**Notes**: 

- Make sure you have Docker, Docker Compose and Node.js installed. 

- The `run.sh` script only works on Linux or MacOS. On Windows, you have to run it in MINGW64 environment (aka. Git bash) - a PowerShell script will be available soon. [See the instructions](https://jcutrer.com/windows/bash-shell-on-windows).

- You need to install PostgreSQL and Redis by yourself, if you don't want to use Docker.

```bash

https://github.com/tranphuquy19/NestJS-EJS-MVC-boilerplate # Clone this repository

cd NestJS-EJS-MVC-boilerplate # Go to the root of the repository

yarn # Install dependencies

bash ./run.sh up -d # will start all services. `-d` will run the services for development mode. 

yarn start:dev # Start the application in development mode

```

### Start using Docker compose

```bash

bash ./run.sh build # Build the application image for production

bash ./run.sh up -p # Start PostgreSQL, Redis, PgAdmin and the application in production mode

bash ./run.sh down # Stop PostgreSQL, Redis, PgAdmin and the application

bash ./run.sh down:volumes # Destroy PostgreSQL, Redis, PgAdmin and the application

```

## Contributing

**I'm looking for help with fixing issues, adding new packages, docs and maintaining

existing ones. It would be very helpful if you submit a pull request with bug fixes.**

## Features

### Environments

- [x] production

- [x] development

### View engine

- [x] EJS

- [x] EJS Partials

- [x] EJS Helpers

- [x] Page render decorator [page.decorator.ts](https://github.com/tranphuquy19/NestJS-EJS-MVC-boilerplate/blob/master/src/shared/decorators/page.decorator.ts#L3)

### API

- [x] RESTful API

- [x] API versioning decorator [api-v1.controller.ts](https://github.com/tranphuquy19/NestJS-EJS-MVC-boilerplate/blob/master/src/shared/decorators/api-v1-controller.decorator.ts#L3)

- [x] API Pagination

- [x] Multiple domains support

### GraphQL

### Caching

- [ ] API Response

- [x] Static files

- [x] Database queries

- [ ] CDN

### Authentication

- [x] Cookies/Session

- [x] Using Redis as Session Store

- [x] Basic auth

- [x] JWT auth

- [x] Refresh token

- [ ] Web-socket auth

- [ ] OAuth Google

- [ ] OAuth Facebook

- [ ] OAuth Github

- [ ] Verify email

- [ ] Time-based One-time password (TOTP)

### Task scheduler

- [ ] Timeout

- [ ] Interval

- [ ] Cron job

### HTTP client

- [ ] RESTful client

- [ ] GraphQL client

- [ ] SOAP client

### Send mail

- [ ] Nodemailer (smtp, password)

- [ ] Email templates

### Payment

- [ ] PayPal

- [ ] Stripe

### Structure

- [x] Repository pattern

- [x] Module path Aliases

### Authorization (Access control)

- [x] Role-based Access Control (RBAC)

- [x] Attribute-based Access Control (ABAC)

- [ ] Can update grants at runtime

- [x] Implemented builder pattern

### Support SEO

- [x] Sitemap generator

- [ ] Google Analytics

- [ ] Open graph

### Notification

- [x] Self-hosted push notification

- [x] Store subscriptions in Redis

- [x] Push notification to specific users

- [x] Push notification to logged in users

- [ ] Push notification to guest users

- [ ] Unsubscribe notification

- [ ] Firebase Cloud Messaging

### I18n

- [x] Support EJS `<%= __('home') %>`, using [i18n](https://www.npmjs.com/package/i18n) package

- [x] Using Cookie

### File Uploader

- [x] Uploader decorator [uploader.decorator.ts](https://github.com/tranphuquy19/NestJS-EJS-MVC-boilerplate/blob/master/src/shared/decorators/uploader.decorator.ts#L7)

- [x] Magic number checker

- [ ] Auto resize images

- [x] Auto optimize images

- [ ] Auto generate video thumbnails

- [ ] Cloudinary

- [ ] AWS S3

### Logging

- [x] Log requests (using [morgan](https://github.com/expressjs/morgan))

- [x] Log requests in `development` environment

- [x] Write logs to file in `production` environment

### Real-time application

- [ ] Socket.IO

- [ ] Redis Pub/Sub

### Debugging config

- [ ] VScode

- [ ] JetBrains's IDEs (WebStorm, IntelliJ IDEA, ...)

- [ ] Node Inspector

### Database

- [x] Pagination

- [ ] Transaction

- [x] Synchronizing Table Schemas

- [ ] Data seeding

- [ ] Multi-database

### Security

- [x] Using [helmet](https://github.com/helmetjs/helmet) package

- [x] CORS

- [ ] CRFS

- [x] Schema validation (validation pipes)

- [ ] Rate limit

- [x] Check uploaded file types with magic number

### Health checks

- [ ] Get stats

- [ ] Stats reports

- [ ] Email health check report

### Git hooks

- [x] Using [husky](https://www.npmjs.com/package/husky)

- [x] Linting (with lint-staged)

- [x] Prettier (just run `yarn format`)

- [x] Integrate Commitizen (use `yarn commit` instead of `git commit`)

### Backup

- [ ] Database backup

### App containerization

- [x] Dockerfile (`development`, `production`)

- [x] Docker-compose

- [x] Improve image build process with [buildkit](https://docs.docker.com/develop/develop-images/build_enhancements/)

- [ ] Kubernetes

- [ ] Skaffold

### CI/CD

- [x] Github actions

- [ ] Circle CI

- [ ] Gitlab pipeline

- [ ] Multi-Stage pipelines

### Testing

- [ ] Unit test

- [ ] E2E

- [ ] Coverage

- [ ] Performance

### Documentations

- [x] Swagger docs `http://localhost:4000/docs`

- [x] Swagger json-docs (just append `-json` to Swagger path. Example: `http://localhost:4000/docs-json`)