🚀 Boilerplate Documentation

📦 Features

⚡ Quick Start

Installation

git clone <repository-url>
cd prisma-boilerplate
npm install

Environment Setup

Create a .env file in the root directory:

DATABASE_URL="postgresql://user:password@localhost:5432/dbname"
JWT_SECRET="your-secret-key"
PORT=3000

Database Setup

npx prisma generate
npx prisma migrate dev

Running the Application

# Development
npm run dev

# Production
npm run build
npm start

Docker Setup

# Build and run with Docker Compose
docker-compose up --build

🔌 API Endpoints

Authentication

{
  "email": "user@example.com",
  "password": "password123",
  "name": "John Doe"
}

Users

# Pagination
?page=1&limit=10

# Search
?search=john

# Filter
?filter[role]=admin

# Sort
?sort=createdAt:desc

# Select Fields
?fields=id,name,email

# Include Relations
?include=posts,comments

🛠️ Project Structure

src/
├── app.ts                 # Main application class
├── server.ts              # Server entry point
├── config/               # Configuration
├── db/                   # Database setup
├── modules/              # Feature modules
│   ├── auth/            # Authentication module
│   ├── user/            # User module
│   └── example/         # Example module
├── routes/              # Route definitions
├── sockets/            # (removed)
└── utils/              # Utilities

🔄 Adding New Modules

1. Create a new directory in src/modules/your-module

2. Create the following files:

• your-module.model.ts - Prisma model definition
• your-module.routes.ts - Route definitions
• YourModuleController.ts - Controller logic
• YourModuleService.ts - Business logic

3. Register your module in src/config/initControllers.ts

🚀 Advanced Features

Query Builder

All endpoints support advanced query features:

• Pagination with page and limit
• Search across specified fields
• Filter by any field with operators
• Sort by multiple fields
• Select specific fields
• Include related data

🔒 Security Features

• JWT-based authentication
• Secure cookie handling
• Rate limiting
• CORS protection
• Helmet security headers
• Input validation

🌟 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.