Skip to content

Commit 2064ae6

Browse files
committed
chore: Update README for 2025 version, enhancing clarity and modernizing content
1 parent c0f86c1 commit 2064ae6

File tree

1 file changed

+34
-35
lines changed

1 file changed

+34
-35
lines changed

README.md

+34-35
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# 🚀 Express TypeScript Boilerplate 2024
1+
# 🚀 Express TypeScript Boilerplate 2025
22

3-
[![CI](https://github.com/edwinhern/express-typescript-2024/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/edwinhern/express-typescript-2024/actions/workflows/ci.yml)
3+
[![CI](https://github.com/edwinhern/express-typescript/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/edwinhern/express-typescript-2024/actions/workflows/ci.yml)
44

55
```code
66
Hey There! 🙌
@@ -9,33 +9,33 @@ Hey There! 🙌
99

1010
## 🌟 Introduction
1111

12-
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.
1313

14-
## 💡 Motivation
14+
## 💡 Why We Made This
1515

16-
This boilerplate aims to:
16+
This starter kit helps you:
1717

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 security and testing
2222

23-
## 🚀 Features
23+
## 🚀 What's Included
2424

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
3939

4040
## 🛠️ Getting Started
4141

@@ -47,9 +47,9 @@ For a visual guide, watch the [video demo](https://github.com/user-attachments/a
4747

4848
#### Step 1: 🚀 Initial Setup
4949

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`
5353

5454
#### Step 2: ⚙️ Environment Configuration
5555

@@ -58,9 +58,9 @@ For a visual guide, watch the [video demo](https://github.com/user-attachments/a
5858

5959
#### Step 3: 🏃‍♂️ Running the Project
6060

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`
6464

6565
## 🤝 Feedback and Contributions
6666

@@ -71,11 +71,12 @@ We'd love to hear your feedback and suggestions for further improvements. Feel f
7171
## 📁 Folder Structure
7272

7373
```code
74-
├── Dockerfile
75-
├── README.md
7674
├── biome.json
77-
├── package-lock.json
75+
├── Dockerfile
76+
├── LICENSE
7877
├── package.json
78+
├── pnpm-lock.yaml
79+
├── README.md
7980
├── src
8081
│ ├── api
8182
│ │ ├── healthCheck
@@ -115,6 +116,4 @@ We'd love to hear your feedback and suggestions for further improvements. Feel f
115116
│ └── server.ts
116117
├── tsconfig.json
117118
└── vite.config.mts
118-
119-
14 directories, 31 files
120119
```

0 commit comments

Comments
 (0)