Skip to content

Commit 9332b16

Browse files
authored
Update README.md
1 parent e42c0bb commit 9332b16

File tree

1 file changed

+2
-34
lines changed

1 file changed

+2
-34
lines changed

README.md

Lines changed: 2 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
# 🚀 Express TypeScript Boilerplate 2024
22

3-
[![Build](https://github.com/edwinhern/express-typescript-2024/actions/workflows/build.yml/badge.svg)](https://github.com/edwinhern/express-typescript-2024/actions/workflows/build.yml)
4-
[![Test](https://github.com/edwinhern/express-typescript-2024/actions/workflows/test.yml/badge.svg)](https://github.com/edwinhern/express-typescript-2024/actions/workflows/test.yml)
5-
[![Code Quality](https://github.com/edwinhern/express-typescript-2024/actions/workflows/code-quality.yml/badge.svg)](https://github.com/edwinhern/express-typescript-2024/actions/workflows/code-quality.yml)
6-
[![Docker Image CI](https://github.com/edwinhern/express-typescript-2024/actions/workflows/docker-image.yml/badge.svg)](https://github.com/edwinhern/express-typescript-2024/actions/workflows/docker-image.yml)
7-
83
``` code
94
Hey There! 🙌
105
🤾 that ⭐️ button if you like this boilerplate.
@@ -14,33 +9,6 @@ Hey There! 🙌
149

1510
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.
1611

17-
## 💡 Motivation
18-
19-
This boilerplate aims to:
20-
21-
- ✨ Reduce setup time for new projects
22-
- 📊 Ensure code consistency and quality
23-
- ⚡ Facilitate rapid development
24-
- 🛡️ Encourage best practices in security, testing, and performance
25-
26-
## 🚀 Features
27-
28-
- 📁 Modular Structure: Organized by feature for easy navigation and scalability
29-
- 💨 Faster Execution with tsx: Rapid TypeScript execution with `tsx` and type checking with `tsc`
30-
- 🌐 Stable Node Environment: Latest LTS Node version in `.nvmrc`
31-
- 🔧 Simplified Environment Variables: Managed with Envalid
32-
- 🔗 Path Aliases: Cleaner code with shortcut imports
33-
- 🔄 Renovate Integration: Automatic updates for dependencies
34-
- 🔒 Security: Helmet for HTTP header security and CORS setup
35-
- 📊 Logging: Efficient logging with `pino-http`
36-
- 🧪 Comprehensive Testing: Setup with Vitest and Supertest
37-
- 🔑 Code Quality Assurance: Husky and lint-staged for consistent quality
38-
- ✅ Unified Code Style: `Biomejs` for consistent coding standards
39-
- 📃 API Response Standardization: `ServiceResponse` class for consistent API responses
40-
- 🐳 Docker Support: Ready for containerization and deployment
41-
- 📝 Input Validation with Zod: Strongly typed request validation using `Zod`
42-
- 🧩 Swagger UI: Interactive API documentation generated from Zod schemas
43-
4412
## 🛠️ Getting Started
4513

4614
### Video Demo
@@ -51,8 +19,8 @@ For a visual guide, watch the [video demo](https://github.com/user-attachments/a
5119

5220
#### Step 1: 🚀 Initial Setup
5321

54-
- Clone the repository: `git clone https://github.com/edwinhern/express-typescript-2024.git`
55-
- Navigate: `cd express-typescript-2024`
22+
- Clone the repository: `git clone https://github.com/coditech0926/express-typescript-swagger.git`
23+
- Navigate: `cd express-typescript-swagger`
5624
- Install dependencies: `npm ci`
5725

5826
#### Step 2: ⚙️ Environment Configuration

0 commit comments

Comments
 (0)