Node-Express-Prisma-Starter-Boilerplate

A production-ready Node.js Express boilerplate with TypeScript, featuring robust architecture, Prisma ORM with generic repository pattern and Object-Oriented Programming (OOP) principles.

Features

• TypeScript Support - Written in TypeScript for better developer experience and type safety.
• Express.js - Fast, unopinionated web framework for Node.js.
• Prisma ORM - Database access with a Generic Repository Pattern, following OOP principles for better maintainability and reusability.
• Redis Integration - Redis support for caching to improve performance.
• Error Handling - Centralized global error handling middleware.
• API Documentation - Auto-generated route documentation.
• Code Quality
  • ESLint for code linting.
  • Prettier for code formatting.
• Event System - Built-in event handling system for better modularization.
• Middleware - Common middleware implementations:
  • Authentication middleware.
  • Error handling middleware.
  • Rate limiting middleware.
  • Pagination middleware.
  • Request validation middleware.
• Postman Collection - Broilerplate.postman_collection.json included for API testing.
• Object-Oriented Architecture - Designed with OOP principles, ensuring modularity, reusability, and scalability.

Prerequisites

• Node.js (v16 or higher)
• npm or yarn
• Redis server
• PostgreSQL or any database supported by Prisma

Installation

1. Clone the repository:

   git clone <repository-url>
   cd <project-name>

2. Install dependencies:

   npm install
   # or
   yarn install

3. Setup environment variables:

   cp .env.example .env

   • Open .env and update the configuration as needed.

4. Generate Prisma client:

   npm run prisma:generate

5. Run database migrations:

   npm run prisma:migrate:dev

6. Seed the database with initial data:

   npm run prisma:seed

Project Structure

src/
├── app/
│   ├── middlewares/       # Express middlewares
│   ├── modules/           # Feature modules
│   │   └───├── constants/
│   │       ├── controllers/
│   │       ├── helpers/
│   │       ├── interfaces/
│   │       ├── routes/
│   │       ├── services/
│   │       └── router.ts
│   └── index.ts          # Express app configuration
├── config/               # Configuration files
├── shared/              # Shared utilities and helpers
├── types/               # TypeScript type definitions
└── server.ts            # Application entry point

Usage

Development Mode

npm run dev
# or
yarn dev

Database Management Scripts

• Generate Prisma client

  npm run prisma:generate

• Run migrations (development)

  npm run prisma:migrate:dev

• Reset database

  npm run prisma:db:reset

• Open Prisma Studio

  npm run prisma:studio

• Seed database

  npm run prisma:seed

API Documentation

• The application automatically logs all available routes.
• Use the provided Postman Collection (Broilerplate.postman_collection.json) to test API endpoints.

Error Handling

The application includes a centralized error-handling system. Any error that occurs is caught and formatted before being sent to the client, ensuring a standardized response structure.

Security Measures

This boilerplate includes several security enhancements:

• Helmet.js for setting security headers.
• Rate Limiting to prevent excessive API requests.
• CORS Configuration for cross-origin security.
• Disabled x-powered-by Header to mask Express usage.
• Request Size Limiting to prevent large payload attacks.

Contributing

Contributions are welcome! Please follow these steps:

1. Fork the repository.
2. Create a new branch (feature/your-feature or fix/your-fix).
3. Commit your changes.
4. Push the branch and create a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.