You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Welcome to the Express TypeScript Boilerplate 2024 – a streamlined, efficient, and scalable foundation for building powerful backend services with modern tools and practices in Express.js and TypeScript.
12
+
Welcome to Express TypeScript Boilerplate 2025 – a simple and ready-to-use starting point for building backend web services with Express.js and TypeScript.
13
13
14
-
## 💡 Motivation
14
+
## 💡 Why We Made This
15
15
16
-
This boilerplate aims to:
16
+
This starter kit helps you:
17
17
18
-
- ✨ Reduce setup time for new projects
19
-
- 📊 Ensure code consistency and quality
20
-
- ⚡ Facilitate rapid development
21
-
- 🛡️ Encourage best practices in security, testing, and performance
18
+
- ✨ Start new projects faster
19
+
- 📊 Write clean, consistent code
20
+
- ⚡ Build things quickly
21
+
- 🛡️ Follow best practices for securityand testing
22
22
23
-
## 🚀 Features
23
+
## 🚀 What's Included
24
24
25
-
- 📁 Modular Structure: Organized by feature for easy navigation and scalability
26
-
- 💨 Faster Execution with tsx: Rapid TypeScript execution with `tsx` and type checking with `tsc`
27
-
- 🌐 Stable Node Environment: Latest LTS Node version in`.nvmrc`
28
-
- 🔧 Simplified Environment Variables: Managed with Envalid
29
-
- 🔗 Path Aliases: Cleaner code with shortcut imports
30
-
- 🔄 Renovate Integration: Automatic updates for dependencies
31
-
- 🔒 Security: Helmet for HTTP header security and CORS setup
32
-
- 📊 Logging: Efficient logging with `pino-http`
33
-
- 🧪 Comprehensive Testing: Setup with Vitest and Supertest
34
-
- ✅ Unified Code Style: `Biomejs` for consistent coding standards
35
-
- 📃 API Response Standardization: `ServiceResponse` class for consistent API responses
36
-
- 🐳 Docker Support: Ready for containerization and deployment
37
-
- 📝 Input Validation with Zod: Strongly typed request validation using `Zod`
38
-
- 🧩 Swagger UI: Interactive API documentation generated from Zod schemas
25
+
- 📁 Well-organized folders: Files grouped by feature so you can find things easily
26
+
- 💨 Fast development: Quick code running with `tsx` and error checking with `tsc`
27
+
- 🌐 Latest Node.js: Uses the newest stable Node.js version from`.tool-versions`
28
+
- 🔧 Safe settings: Environment settings checked with Zod to prevent errors
29
+
- 🔗 Short import paths: Clean code with easy imports using path shortcuts
30
+
- 🔄 Auto-updates: Keeps dependencies up-to-date with Renovate
31
+
- 🔒 Better security: Built-in protection with Helmet and CORS settings
32
+
- 📊 Easy tracking: Built-in logging with `pino-http`
33
+
- 🧪 Ready-to-test: Testing tools with Vitest and Supertest already set up
34
+
- ✅ Clean code: Consistent coding style with `Biomejs`
35
+
- 📃 Standard responses: Unified API responses using `ServiceResponse`
36
+
- 🐳 Easy deployment: Ready for Docker containers
37
+
- 📝 Input checking: Request validation using Zod
38
+
- 🧩 API browser: Interactive API docs with Swagger UI
39
39
40
40
## 🛠️ Getting Started
41
41
@@ -47,9 +47,9 @@ For a visual guide, watch the [video demo](https://github.com/user-attachments/a
47
47
48
48
#### Step 1: 🚀 Initial Setup
49
49
50
-
- Clone the repository: `git clone https://github.com/edwinhern/express-typescript-2024.git`
51
-
- Navigate: `cd express-typescript-2024`
52
-
- Install dependencies: `npm ci`
50
+
- Clone the repository: `git clone https://github.com/edwinhern/express-typescript.git`
51
+
- Navigate: `cd express-typescript`
52
+
- Install dependencies: `pnpm install`
53
53
54
54
#### Step 2: ⚙️ Environment Configuration
55
55
@@ -58,9 +58,9 @@ For a visual guide, watch the [video demo](https://github.com/user-attachments/a
58
58
59
59
#### Step 3: 🏃♂️ Running the Project
60
60
61
-
- Development Mode: `npm run dev`
62
-
- Building: `npm run build`
63
-
- Production Mode: Set `.env` to `NODE_ENV="production"`then `npm run build && npm run start:prod`
61
+
- Development Mode: `pnpm start:dev`
62
+
- Building: `pnpm build`
63
+
- Production Mode: Set `NODE_ENV="production"`in `.env` then `pnpm build && pnpm start:prod`
64
64
65
65
## 🤝 Feedback and Contributions
66
66
@@ -71,11 +71,12 @@ We'd love to hear your feedback and suggestions for further improvements. Feel f
71
71
## 📁 Folder Structure
72
72
73
73
```code
74
-
├── Dockerfile
75
-
├── README.md
76
74
├── biome.json
77
-
├── package-lock.json
75
+
├── Dockerfile
76
+
├── LICENSE
78
77
├── package.json
78
+
├── pnpm-lock.yaml
79
+
├── README.md
79
80
├── src
80
81
│ ├── api
81
82
│ │ ├── healthCheck
@@ -115,6 +116,4 @@ We'd love to hear your feedback and suggestions for further improvements. Feel f
0 commit comments