{"id":26047628,"url":"https://github.com/edwinhern/express-typescript-2024","last_synced_at":"2025-04-12T06:02:41.671Z","repository":{"id":214137758,"uuid":"735783287","full_name":"edwinhern/express-typescript-2024","owner":"edwinhern","description":"Express + TypeScript starter template ","archived":false,"fork":false,"pushed_at":"2025-04-11T02:04:25.000Z","size":1239,"stargazers_count":924,"open_issues_count":9,"forks_count":188,"subscribers_count":11,"default_branch":"master","last_synced_at":"2025-04-12T06:00:04.638Z","etag":null,"topics":["bolierplate","docker","docker-compose","exception-handling","express","express-docker-compose","express-typescript","express-typescript-boilerplate","express-typescript-tutorial","expresstypescript","logging","typescript","vitest"],"latest_commit_sha":null,"homepage":"https://express.hernserver.com/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/edwinhern.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-26T04:22:17.000Z","updated_at":"2025-04-11T20:02:19.000Z","dependencies_parsed_at":"2024-01-07T10:27:49.036Z","dependency_job_id":"07e2fbb0-03f6-40d2-ba8e-c25ac9b6cb6a","html_url":"https://github.com/edwinhern/express-typescript-2024","commit_stats":null,"previous_names":["edwinhern/express-typescript-2024"],"tags_count":37,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwinhern%2Fexpress-typescript-2024","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwinhern%2Fexpress-typescript-2024/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwinhern%2Fexpress-typescript-2024/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/edwinhern%2Fexpress-typescript-2024/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/edwinhern","download_url":"https://codeload.github.com/edwinhern/express-typescript-2024/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248525137,"owners_count":21118616,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bolierplate","docker","docker-compose","exception-handling","express","express-docker-compose","express-typescript","express-typescript-boilerplate","express-typescript-tutorial","expresstypescript","logging","typescript","vitest"],"created_at":"2025-03-07T23:12:24.584Z","updated_at":"2025-04-12T06:02:41.546Z","avatar_url":"https://github.com/edwinhern.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 🚀 Express TypeScript Boilerplate 2024\n\n[![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)\n\n```code\nHey There! 🙌\n🤾 that ⭐️ button if you like this boilerplate.\n```\n\n## 🌟 Introduction\n\nWelcome 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.\n\n## 💡 Motivation\n\nThis boilerplate aims to:\n\n- ✨ Reduce setup time for new projects\n- 📊 Ensure code consistency and quality\n- ⚡ Facilitate rapid development\n- 🛡️ Encourage best practices in security, testing, and performance\n\n## 🚀 Features\n\n- 📁 Modular Structure: Organized by feature for easy navigation and scalability\n- 💨 Faster Execution with tsx: Rapid TypeScript execution with `tsx` and type checking with `tsc`\n- 🌐 Stable Node Environment: Latest LTS Node version in `.nvmrc`\n- 🔧 Simplified Environment Variables: Managed with Envalid\n- 🔗 Path Aliases: Cleaner code with shortcut imports\n- 🔄 Renovate Integration: Automatic updates for dependencies\n- 🔒 Security: Helmet for HTTP header security and CORS setup\n- 📊 Logging: Efficient logging with `pino-http`\n- 🧪 Comprehensive Testing: Setup with Vitest and Supertest\n- ✅ Unified Code Style: `Biomejs` for consistent coding standards\n- 📃 API Response Standardization: `ServiceResponse` class for consistent API responses\n- 🐳 Docker Support: Ready for containerization and deployment\n- 📝 Input Validation with Zod: Strongly typed request validation using `Zod`\n- 🧩 Swagger UI: Interactive API documentation generated from Zod schemas\n\n## 🛠️ Getting Started\n\n### Video Demo\n\nFor a visual guide, watch the [video demo](https://github.com/user-attachments/assets/b1698dac-d582-45a0-8d61-31131732b74e) to see the setup and running of the project.\n\n### Step-by-Step Guide\n\n#### Step 1: 🚀 Initial Setup\n\n- Clone the repository: `git clone https://github.com/edwinhern/express-typescript-2024.git`\n- Navigate: `cd express-typescript-2024`\n- Install dependencies: `npm ci`\n\n#### Step 2: ⚙️ Environment Configuration\n\n- Create `.env`: Copy `.env.template` to `.env`\n- Update `.env`: Fill in necessary environment variables\n\n#### Step 3: 🏃‍♂️ Running the Project\n\n- Development Mode: `npm run dev`\n- Building: `npm run build`\n- Production Mode: Set `.env` to `NODE_ENV=\"production\"` then `npm run build \u0026\u0026 npm run start`\n\n## 🤝 Feedback and Contributions\n\nWe'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!\n\n🎉 Happy coding!\n\n## 📁 Folder Structure\n\n```code\n├── Dockerfile\n├── README.md\n├── biome.json\n├── package-lock.json\n├── package.json\n├── src\n│   ├── api\n│   │   ├── healthCheck\n│   │   │   ├── __tests__\n│   │   │   │   └── healthCheckRouter.test.ts\n│   │   │   └── healthCheckRouter.ts\n│   │   └── user\n│   │       ├── __tests__\n│   │       │   ├── userRouter.test.ts\n│   │       │   └── userService.test.ts\n│   │       ├── userController.ts\n│   │       ├── userModel.ts\n│   │       ├── userRepository.ts\n│   │       ├── userRouter.ts\n│   │       └── userService.ts\n│   ├── api-docs\n│   │   ├── __tests__\n│   │   │   └── openAPIRouter.test.ts\n│   │   ├── openAPIDocumentGenerator.ts\n│   │   ├── openAPIResponseBuilders.ts\n│   │   └── openAPIRouter.ts\n│   ├── common\n│   │   ├── __tests__\n│   │   │   ├── errorHandler.test.ts\n│   │   │   └── requestLogger.test.ts\n│   │   ├── middleware\n│   │   │   ├── errorHandler.ts\n│   │   │   ├── rateLimiter.ts\n│   │   │   └── requestLogger.ts\n│   │   ├── models\n│   │   │   └── serviceResponse.ts\n│   │   └── utils\n│   │       ├── commonValidation.ts\n│   │       ├── envConfig.ts\n│   │       └── httpHandlers.ts\n│   ├── index.ts\n│   └── server.ts\n├── tsconfig.json\n└── vite.config.mts\n\n14 directories, 31 files\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedwinhern%2Fexpress-typescript-2024","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fedwinhern%2Fexpress-typescript-2024","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fedwinhern%2Fexpress-typescript-2024/lists"}