miZyind/nestjs-demo

A NestJS demo project.

NestJS Demo

🌌 Techniques

• NestJS - A progressive NodeJS framework for building efficient, reliable and scalable server-side applications.
  • @nestjs/cli - CLI tool for Nest.
  • @nestjs/jwt - Utilities module based on the JWT package.
  • @nestjs/config - Configuration module for Nest.
  • @nestjs/typeorm - TypeORM module for Nest.
  • @nestjs/swagger - OpenAPI (Swagger) module for Nest.
  • @nestjs/passport - .Passport module for Nest.
  • @nestjs/platform-express - Under the hood, Nest makes use of Express.
  • @nestjs/microservices - In Nest, a microservice is fundamentally an application.
• Swagger - API Documentation & Design Tools for Teams.
• RabbitMQ - Messaging that just works.
  • amqplib - AMQP 0-9-1 library and client for NodeJS.
  • amqp-connection-manager - Auto-reconnect and round robin support for amqplib.
• Passport - Simple, unobtrusive authentication for NodeJS.
  • passport-jwt - Passport authentication using JSON Web Tokens.
• RxJS - A reactive programming library for JS.
• Bcrypt - A library to help you hash passwords.
• TypeORM - Amazing ORM for TS and JS.
• Reflect Metadata - Prototype for a Metadata Reflection API for ECMAScript.
• Class Validator - Decorator-based property validation for classes.
• Class Transformer - Decorator-based transform-, serializ-, and deserialization between objects and classes.
• TypeScript - Typed JS at Any Scale.
• Prettier - Opinionated Code Formatter.
• ESLint - Pluggable JS linter.
  • typescript-eslint - Monorepo for all the tooling which enables ESLint to support TypeScript.
  • eslint-config-prettier - Turns off all rules that are unnecessary or might conflict with Prettier.
  • eslint-plugin-prettier - ESLint plugin for Prettier formatting.
  • eslint-plugin-import-x - ESLint plugin with rules that help validate proper imports.
• Husky - Git hooks made easy.
  • commitlint - Lint commit messages.
    • @commitlint/cli - Primary way to interact with commitlint.
    • @commitlint/config-conventional - Shareable commitlint config enforcing conventional commits.

🔮 Usage

Run development environment:

# Install packages
$ yarn
# Up docker compose environment
$ docker-compose up
# Setup dotenv variables
$ cp .env.example .env
# Launch app
$ yarn dev

Build & Run production environment:

# Install packages
$ yarn
# Build project
$ yarn build
# Launch app through Yarn
$ yarn start
# Launch app through Node
$ node dist/main.js

🖋 Author

miZyind <mizyind.dev>

📇 License

Licensed under the MIT License.