boilerplate-express-prisma-ts
v1.0.2
Published

Readme
🚀 Boilerplate Express Prisma TS
Hey There! 🙌
🤾 that ⭐️ button if you like this boilerplate. 🌟 Introduction
Welcome to Boilerplate Express Prisma TS – a powerful, efficient, and scalable foundation for building backend services using Express.js and TypeScript, following modern best practices and technologies. 🚀
💡 Motivation
This boilerplate aims to:
- ✨ Reduce setup time for new projects
- 📊 Ensure code consistency and quality
- ⚡ Facilitate rapid development
- 🛡️ Encourage best practices in security, and performance
🧰 Tech Stack
- Node.js (LTS)
- Express.js
- TypeScript
- Prisma ORM
- Mysql (or your DB of choice)
- Zod for schema validation
- Winston for logging
- Helmet & CORS for security
🚀 Features
- 📁 Modular Structure: Organized by feature for easy navigation and scalability
- 💨 Faster Execution with tsx: Rapid TypeScript execution with
tsxand type checking withtsc - 🌐 Stable Node Environment: Latest LTS Node version in
.nvmrc - 🔧 Simplified Environment Variables: Managed with Envalid
- 🔗 Path Aliases: Cleaner code with shortcut imports
- 🔄 Renovate Integration: Automatic updates for dependencies
- 🔒 Security: Helmet for HTTP header security and CORS setup
- 📊 Logging: Efficient logging with winston
- 📝 Input Validation with Zod: Strongly typed request validation using
Zod
🛠️ Getting Started
Step-by-Step Guide
Step 1: 🚀 Initial Setup
- Create a New Project Folder
mkdir my-new-api
cd my-new-api- Run Command:
npx boilerplate-express-prisma-tsOR
git clone https://github.com/michaeldavidvinc1/boilerplate-node-express-prisma.gitStep 2: ⚙️ Environment Configuration
- Create
.env: Copy.env.exampleto.env - Update
.env: Fill in necessary environment variables
Step 3: 🏃♂️ Running the Project
- Development Mode:
npm run dev - Building:
npm run build - Production Mode: Set
.envtoNODE_ENV="production"thennpm run build && npm run start
🤝 Feedback and Contributions
We'd love to hear your feedback and suggestions for further improvements. Feel free to contribute and join us in making backend development cleaner and faster!
🎉 Happy coding!
