josephgoksu / prime-nestjs Goto Github PK

A production-ready NestJS boilerplate using Typescript, Postgres, TypeORM, and Docker.

License: MIT License

Shell 5.14% JavaScript 12.61% Dockerfile 1.39% TypeScript 80.86%

nestjs nestjs-boilerplate nestjs-backend nestjs-postgres nestjs-best-practices nestjs-starter-template typescript typeorm nest nestjs-library

prime-nestjs's Introduction

NestJS Boilerplate

📖 Description

Introducing the NestJS boilerplate - a great way to get started on your next Node.js project! It's built using the latest version of NestJS, which is a powerful and flexible framework for creating efficient and scalable server-side applications. The boilerplate includes TypeScript, PostgreSQL, and JWT authentication right out of the box, so you don't have to worry about setting those up yourself.

Other awesome features include configuration support with Dotenv, RBAC and CBAC for authorization, TypeORM for interacting with databases, Swagger for API documentation, and Docker Compose for container orchestration. Plus, the boilerplate also comes with pre-configured linting tools and secure HTTP headers with Helmet.

Getting started is easy - just clone the repository, install the dependencies, and you're ready to start building your next great idea!

🚀 Features

📱 NestJS — latest version
🎉 TypeScript - Type checking
⚙️ Dotenv - Supports environment variables
🗝 Authentication - JWT, RSA256
🏬 Authorization - RBAC, CBAC
🏪 TypeORM - Database ORM
🏪 PostgreSQL - Open-Source Relational Database
🧠 Configuration - Single config for all
📃 Swagger - API Documentation
🐳 Docker Compose - Container Orchestration
🔐 Helmet - secure HTTP headers
😴 Insomnia - Insomnia config for endpoints
📏 ESLint — Pluggable JavaScript linter
💖 Prettier - Opinionated Code Formatter
✨ Commitlint - Lint your conventional commits
🕵️‍♂️ Code Scanning - Code scanning with CodeQL

Quick Setup (Production)

bash ./setup.sh

Installation (Development)

$ 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

Endpoints

Install the insomnia app
Import the endpoints.json file
Enjoy

Generate SSL certificates

Generate an RSA private key, of size 2048, and output it to a file named key.pem:

openssl genrsa -out private_key.pem 2048

# It needs be copied&pasted from terminal manually
awk 'NF {sub(/\r/, ""); printf"%s\\n",$0;}' private_key.pem

Extract the public key from the key pair, which can be used in a certificate:

openssl rsa -in private_key.pem -outform PEM -pubout -out public_key.pem

# It needs be copied&pasted from terminal manually
awk 'NF {sub(/\r/, ""); printf "%s\\n",$0;}' public_key.pem

📝 License

This project is licensed under the MIT License - see the LICENSE.md file for more information.

_{Joey Goksu}
📖

Made with ♥ by Joseph Göksu

Star History

prime-nestjs's People

Contributors

Stargazers

Watchers

Forkers

mrcorncob rubiin liorzmetis vitaliyinshakov luconico oussamamaroufi alicantorun peymancyb jy-base jarveypaulo duniapay jeff-maxst bkv1409 mahendradv jc-coder tiagolimarocha raznyenuzdy johnathandinh lollobene convivitybackendteam mauriciocruells l3r amareshsahoo leroidavid nikhil-shrestha the-dev-stuff duytran-agilityio bzilee andrew-butov kouameyao abrom8 ashrafdev marco-quintella hidding-dev samu975 ohrimenkosv53 mjk14 phuocanonydev14 sonthanhdan kennethross sayanmoulick abhishekbhartiind joo97 f15r jurstv bipinparajuli rajanwalia9 armamini thejuggernaut01 iarabie yasir101 khairul111010 curious-rakib codegrorg anhgeeky mikayel00

prime-nestjs's Issues

[BUG]

Describe the bug
Docker-Compose not installed when install docker compose

To Reproduce
Steps to reproduce the behaviour:

run bash ./setup.sh

Environment (please complete the following information):

OS: Ubuntu 22.04
Docker version 20.10.22
Docker Compose version v2.14.1

[REQUEST] Auto certificate creation

Steps

Auto certificate creation - SHA256
Add to setup.sh

[REQUEST] OpenTelemetry Integration

Is your feature request related to a problem? Please describe.
I want to Monitor the Application Performance. It will allow us to improve the codebase using traces and metrics.

Describe the solution you'd like
I would like to implement OpenTelemetry into the project.

Describe alternatives you've considered
As an alternative, we can use Apache-2.0 licenced APM tool. We don't have an alternative yet.

Additional context
https://opentelemetry.io/docs/instrumentation/js/getting-started/nodejs/