Express + Typescript + Swagger + Zod [Template]

Express 🚀 template, including Typesafety 🛡, with automatic Swagger OpenApi 📚 docs generator and Zod validator 🦄

✨ Features

• 🚀 Express NodeJS server
• 📚 Swagger OpenApi definition automatically generated based on your Zod Schemas, served vía Swagger UI
• 🦄 Zod Validate inputs and outputs, type Req and Res objects automagically, under a Typesafety environment
• 📁 Scalable Project Structure, split features into modules
• 🧪 Powerful testing suite setup with Vitest and Supertest. Unitary and Integration test included, +90% code coverage report included!
• 📄 Morgan Log retention. Save your request logs automatically with an automated rotating write stream
• 🌲 Pino logger
• ❌ Global Error Handler included
• ❤️‍🩹 Monitoring Health check endpoint included
• 🔒 Security middlewares provided: Helmet for HTTP header security, CORS setup, and Rate Limiting
• 💉 InversifyJS Dependency Injection
• 🌐 Latest stable NodeJS working environment, with .env config variables validated with Zod
• 🎨 ESLint & Prettier as linter and formatter
• 🐶 Pre-Commit and Commit Husky hooks (Runs linter and formatter before any commit against staged files only!)
• 💄 Commit nomenclature rules following Conventional Commit Format and Commitizen CLI (emoji powered)
• 🚀 Release management policy with commit-and-tag-version, including automagically CHANGELOG.md generation, version bumping and GitTags
• 🔦 Included npm-check to check for outdated, incorrect, and unused dependencies.
• 🥷🏻 Included better-npm-audit to check for dependency vulnerabilities

🛠 Getting Started

npm ci                  # Install dependencies
cp .env.example .env    # And fill .env file variables
npm run dev             # Launch project locally

🎨 Linter & Formatter

npm run lint         # Run ESLint
npm run format       # Run Prettier

⛩ Git Commit with Commitizen

git add .            # Add files
npm run cz           # Commit with Commitizen CLI

🚀 Release a new version

npm run release             # Bump version and generate CHANGELOG.md
git push --follow-tags      # Push changes and GitTag to origin

🔦 Check vulnerabilities and update outdated dependencies

npm run npm:audit     # Check dependency vulnerabilities
npm run npm:check     # Check outdated dependencies

🏗 Build and launch

npm run build         # Compile project
npm run start         # Launch

🧪 Testing

npm run test                # Run all tests
npm run test:cov            # Run all tests with code coverage report
npm run test:unit           # Run unitary tests
npm run test:integration    # Run integration tests