The Express Boilerplate

🚀 A production-ready Express.js boilerplate with TypeScript, Prisma, and PostgreSQL

✨ Features

🛠 Core Technologies

• Express.js - Fast, unopinionated, minimalist web framework
• TypeScript - JavaScript with syntax for types
• Prisma - Next-generation ORM for Node.js and TypeScript
• PostgreSQL - Advanced open-source relational database

🔒 Security & Performance

• Helmet - Secure Express apps with various HTTP headers
• CORS - Cross-Origin Resource Sharing middleware
• Rate Limiting - Basic rate-limiting middleware
• Express Basic Auth - Simple basic auth middleware

📊 Monitoring & Logging

• Morgan - HTTP request logger
• Winston - Multi-transport async logging
• Prometheus - Monitoring and alerting toolkit
• Grafana Loki - Log aggregation system

🧪 Development & Testing

• Jest - Delightful JavaScript Testing Framework
• ESLint - Pluggable linting utility
• Prettier - Opinionated code formatter
• Nodemon - Auto-reload during development

🚀 Quick Start

Prerequisites

• Node.js (v18 or higher)
• PostgreSQL
• Redis (optional, for caching)

Installation

1. Clone the repository:

git clone https://github.com/yourusername/the-express-boilerplate.git
cd the-express-boilerplate

2. Install dependencies:

npm install

3. Set up environment variables:

cp .env.development .env

4. Start the development server:

npm run dev:start

📁 Project Structure

├── src/
│   ├── __tests__/       # Test files
│   ├── config/         # Configuration files
│   ├── helpers/        # Helper functions and constants
│   ├── loaders/        # Startup process modules
│   ├── middleware/     # Custom middleware
│   ├── routes/         # API routes
│   ├── types/          # TypeScript type definitions
│   ├── utils/          # Utility functions
│   ├── bootstrap.ts    # Application bootstrap
│   └── server.ts       # Server entry point
├── prisma/            # Prisma schema and migrations
└── docker/            # Docker configuration files

🛠 Development

Available Scripts

• npm run dev:start - Start the development server with hot-reload
• npm run build - Build the project
• npm run prod:start - Start the production server
• npm test - Run tests

🔒 Environment Variables

Create a .env file in the root directory:

# Server
PORT=3000
NODE_ENV=development

# Database
DATABASE_URL="postgresql://user:password@localhost:5432/dbname"

# JWT
JWT_SECRET=your-secret-key

# Redis
REDIS_URL="redis://localhost:6379"

🐳 Docker Support

Build and run with Docker Compose:

docker-compose up --build

📈 Monitoring

This boilerplate includes:

• Prometheus metrics at /metrics
• Grafana Loki for log aggregation
• Response time monitoring
• Custom metrics support

🧪 Testing

Run tests with Jest:

npm test

Test files are located in src/__tests__/

📜 License

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

🤝 Contributing

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

1. Fork the project
2. Create your feature branch (git checkout -b feature/AmazingFeature)
3. Commit your changes (git commit -m 'Add some AmazingFeature')
4. Push to the branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

📫 Support

For support, please open an issue in the GitHub repository.