edwinhern / express-typescript-2024 Goto Github PK

Express + TypeScript + Boilerplate for Web / API App

Home Page: https://express.hernandezserver.com/

License: MIT License

TypeScript 95.22% Dockerfile 1.09% Shell 0.79% JavaScript 2.91%

bolierplate docker docker-compose exception-handling express express-docker-compose express-typescript express-typescript-boilerplate express-typescript-tutorial expresstypescript jest logging ts-jest typescript

express-typescript-2024's Introduction

🚀 Express TypeScript Boilerplate 2024

🌟 Introduction

Welcome to the Express TypeScript Boilerplate 2024 – a streamlined, efficient, and scalable foundation for building powerful backend services. This boilerplate merges modern tools and practices in Express.js and TypeScript, enhancing productivity, code quality, and performance.

💡 Motivation and Intentions

Developed to streamline backend development, this boilerplate is your solution for:

✨ Reducing setup time for new projects.
📊 Ensuring code consistency and quality.
⚡ Facilitating rapid development with cutting-edge tools.
🛡️ Encouraging best practices in security, testing, and performance.

🚀 Features

📁 Modular Structure: Organized by feature for easy navigation and scalability.
💨 Faster Execution with tsx: Rapid TypeScript execution with esbuild, complemented by tsc for type checking.
🌐 Stable Node Environment: Latest LTS Node version in .nvmrc.
🔧 Simplified Environment Variables with Envalid: Centralized and easy-to-manage configuration.
🔗 Path Aliases: Cleaner code with shortcut imports.
🔄 Dependabot Integration: Automatic updates for secure and up-to-date dependencies.
🔒 Security: Helmet for HTTP header security and CORS setup.
📊 Logging: Efficient logging with pino-http.
🧪 Comprehensive Testing: Robust setup with Vitest and Supertest.
🔑 Code Quality Assurance: Husky and lint-staged for consistent quality.
✅ Unified Code Style: ESLint and Prettier for a consistent coding standard.
📃 API Response Standardization: ServiceResponse class for consistent API responses.
🐳 Docker Support: Ready for containerization and deployment.
📝 Input Validation with Zod: Strongly typed request validation using Zod.
🧩 API Spec Generation: Automated OpenAPI specification generation from Zod schemas to ensure up-to-date and accurate API documentation.

🛠️ Getting Started

Step 1: 🚀 Initial Setup

Clone the repository: git clone https://github.com/edwinhern/express-typescript-2024.git
Navigate: cd express-typescript-2024
Install dependencies: npm ci

Step 2: ⚙️ Environment Configuration

Create .env: Copy .env.template to .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 .env to NODE_ENV="production" then npm run build && npm run start

📁 Project Structure

.
├── api
│   ├── healthCheck
│   │   ├── __tests__
│   │   │   └── healthCheckRouter.test.ts
│   │   └── healthCheckRouter.ts
│   └── user
│       ├── __tests__
│       │   ├── userRouter.test.ts
│       │   └── userService.test.ts
│       ├── userModel.ts
│       ├── userRepository.ts
│       ├── userRouter.ts
│       └── userService.ts
├── api-docs
│   ├── __tests__
│   │   └── openAPIRouter.test.ts
│   ├── openAPIDocumentGenerator.ts
│   ├── openAPIResponseBuilders.ts
│   └── openAPIRouter.ts
├── common
│   ├── __tests__
│   │   ├── errorHandler.test.ts
│   │   └── requestLogger.test.ts
│   ├── middleware
│   │   ├── errorHandler.ts
│   │   ├── rateLimiter.ts
│   │   └── requestLogger.ts
│   ├── models
│   │   └── serviceResponse.ts
│   └── utils
│       ├── commonValidation.ts
│       ├── envConfig.ts
│       └── httpHandlers.ts
├── index.ts
└── server.ts

🤝 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!

express-typescript-2024's People

Contributors

Stargazers

Watchers

Forkers

jomardiago marcin-piekarski toyin5 de-hype jortega0033 ifeekz fazil-amir ibilalchaudhary torypages ercumentlacin brijesh59 darkmift 1001josias magyztech darren120 gligadumitru wwkkww tnhai adnan909 prowlee andreasjoensson nikola43 gi4no parag60288 indwr yogeshvar xcodemuse irocker04 mrzahidfaiz chakyiu redidizzy shahidx0x kaycodes11 martinbogner-aparavi hesam-init baris1892 maoapp whoiscass developeryamin melalj csehitesh ismaelezequiel ggiampietro

express-typescript-2024's Issues

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

chore(deps): lock file maintenance

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

fix(deps): update dependency pino-http to v10

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

chore(deps): update dependency eslint to v9

Detected dependencies

dockerfile

Dockerfile

github-actions

.github/workflows/build.yml

actions/checkout v4

actions/setup-node v4

.github/workflows/codeql.yml

actions/checkout v4

github/codeql-action v3

github/codeql-action v3

github/codeql-action v3

.github/workflows/docker-image.yml

actions/checkout v4

docker/login-action v3

.github/workflows/release.yml

actions/checkout v4

actions/setup-node v4

npm

package.json

@asteasolutions/zod-to-openapi ^7.0.0

cors ^2.8.5

dotenv ^16.4.5

envalid ^8.0.0

express ^4.19.2

express-rate-limit ^7.2.0

helmet ^7.1.0

http-status-codes ^2.3.0

pino-http ^9.0.0

swagger-ui-express ^5.0.0

zod ^3.22.4

@commitlint/cli ^19.2.1

@commitlint/config-conventional ^19.1.0

@semantic-release/changelog ^6.0.3

@semantic-release/git ^10.0.1

@semantic-release/github ^10.0.3

@types/cors ^2.8.17

@types/express ^4.17.21

@types/supertest ^6.0.2

@types/swagger-ui-express ^4.1.6

@typescript-eslint/eslint-plugin ^7.5.0

@typescript-eslint/parser ^7.5.0

@vitest/coverage-v8 ^1.4.0

eslint ^8.57.0

eslint-config-prettier ^9.1.0

eslint-plugin-prettier ^5.1.3

eslint-plugin-simple-import-sort ^12.0.0

husky ^9.0.11

lint-staged ^15.2.2

pino-pretty ^11.0.0

prettier ^3.2.5

rimraf ^5.0.5

semantic-release ^23.0.8

supertest ^7.0.0

tsup ^8.0.2

tsx ^4.7.2

typescript ^5.4.4

vite-tsconfig-paths ^4.3.2

vitest ^1.3.1

nvm

.nvmrc

Check this box to trigger a request for Renovate to run again on this repository

Recommendation - use envalid

Great template!

I recommend letting envalid handle envirment sanitation and validation.

https://www.npmjs.com/package/envalid

Would be happy to apply & refactor if you interested to explore further.

Not compiling TS with `npm run dev`

It looks like that the TS code is not being recompiled when there's a change.
Did I miss something?

Here's my workaround:

    "dev": "tsc-watch --noClear --onSuccess \"tsx ./dist/index.js\"",

cannot access your website

express.hernandezserver.com/

Help Wanted: Implementing JWT Authentication for API Routes

Overview

We are planning to integrate JWT-based authentication into our existing API. This feature aims to secure our routes while providing flexibility to exempt certain routes from requiring authentication. Additionally, we want to ensure that our Swagger documentation accurately reflects the authentication requirements for each route.

Requirements

Implement JWT authentication middleware that can be easily applied to selected routes.
Ensure a mechanism is in place to mark certain routes as public (no authentication required) while defaulting to private (authentication required).
Update our Swagger/OpenAPI documentation to reflect the authentication status of each route, enhancing clarity for API consumers.

Proposed Solution

I propose the development of a reusable function or middleware that encapsulates the following functionalities:

JWT Authentication: A middleware that validates JWT tokens for protected routes.
Route Configuration: Enhance our route setup to include authentication requirements. This could be a flag or setting within the route's configuration.
Swagger Documentation: Automatically update our OpenAPI documentation based on the route's authentication requirements.

Example Concept

Here's a conceptual approach to how we might define a route with this new system:

Contribution Guidelines

Fork the repository and create a new branch for your feature.
Write clean, readable, and well-documented code.
Ensure that existing tests pass and write new tests as necessary to cover the authentication functionality.
Update the README and any relevant documentation to reflect the changes.
Submit a pull request with a clear description of the changes and any other relevant information.

Discussion

I'm open to ideas on how best to implement this feature and would love to collaborate with anyone interested in contributing. If you have experience with JWT authentication or have suggestions on improving this proposal, please feel free to share your thoughts or submit a pull request.