https://github.com/losefor/nest-starter

Production grade nest js starter Boilerplate project designed to kickstart the development of a Nest.js application with a focus on production-level quality, performance, and best practices.
https://github.com/losefor/nest-starter

erd nest nestjs node nodejs postgresql prisma sharpjs

Last synced: 8 days ago
JSON representation

Production grade nest js starter Boilerplate project designed to kickstart the development of a Nest.js application with a focus on production-level quality, performance, and best practices.

• Host: GitHub
• URL: https://github.com/losefor/nest-starter
• Owner: losefor
• Created: 2023-08-30T12:33:44.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-10T07:29:01.000Z (over 1 year ago)
• Last Synced: 2024-11-14T01:31:57.038Z (2 months ago)
• Topics: erd, nest, nestjs, node, nodejs, postgresql, prisma, sharpjs
• Language: TypeScript
• Homepage:
• Size: 1.07 MB
• Stars: 6
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Getting Started with Nest.js

Welcome to your journey with Nest.js! This README provides an overview of how to set up a production-grade Nest.js application using some of the best tools and libraries available.

## Prerequisites

Before you begin, ensure you have the following prerequisites installed:

- Node.js (v14 or later)

- npm or Yarn

## Installation

1. Clone this repository:

```bash

   git clone https://github.com/losefor/nest-starter

   cd nest-starter

```

2.Install dependencies:

```bash

npm install

# or

yarn install

```

## features

### ERD (Auto generated)

![Auto generated erd](./src/prisma/generated-erd.svg)

### Versioning

Versioning, especially in the context of software development and APIs, brings several benefits that contribute to efficient collaboration, compatibility, and overall project management

## Production-Grade Tools and Libraries

To ensure the reliability, security, and performance of our Nest.js application in production, we should use the following tools and libraries:

- [x] **express**: The foundation of Nest.js, providing a fast and minimalist web framework.

- [x] **helmet**: Enhances security by setting appropriate HTTP headers.

- [x] **morgan**: Logs incoming requests and responses for debugging and monitoring.

- [x] **class-validator**: Data validation and sanitization to prevent vulnerabilities.

- [x] **passport.js**: Authentication middleware with support for various strategies.

- [x] **cors**: Middleware to handle Cross-Origin Resource Sharing.

- [x] **pino**: Logging libraries for structured and customizable logs.

- [x] **prisma**: A powerful Object-Relational Mapping library for database interactions.

- [ ] **Memcached**: In-memory caching solutions for improved performance.

- [ ] **nodemailer**: Sending emails, useful for features like password resets.

  - [ ] Setup template system

- [x] **pm2**: Process manager for monitoring, restarting, and load balancing.

- [x] **helmet**: Content Security Policy middleware to prevent XSS attacks.

- [x] **jest**: Testing frameworks for unit and integration tests.

- [ ] **supertest**: Library for testing HTTP requests and responses.

- [x] **eslint**: Static code analysis tool for code quality checks.

- [x] **prettier**: Code formatting tool for maintaining consistent styles.

- [x] **swagger**: Documenting your API endpoints for easy consumption.

  - [x] security auth before entering swagger

- [x] **i18n**: Localization functionality.

- [x] **sharp**: Image manipulation library used for image optimization

- [x] **@casl/ability**: ACL authorization

  - [ ] Cache `ability` instance for recent active users

- [ ] **husky**: Set up git hooks

- [x] **multer**: Multipart handler to upload files

  - [x] Digital ocean upload files

  - [ ] Maintenance and Cleanup - Implement a routine to clean up unused or expired images from your storage solution. Set up cron jobs or background tasks to perform this cleanup.

  - [ ] Monitoring and Logging - Set up monitoring and logging to track image-related activities, including uploads, retrievals, and errors. Monitoring helps you identify and address performance issues or anomalies.

- [ ] **docker**: Docker image for the app

## Contributing

Contributions are welcome! If you find any issues or have improvements to suggest, feel free to open a pull request.

Happy coding!