Skip to content

veyricdev/express_v5_typescript_boilerplate

Repository files navigation

Express V5 Boilerplate

🎉 Introduction

Welcome to the Express V5 TypeScript Boilerplate

🚀 Features

  • 📁 Modular Structure
  • 💻 TypeScript Support
  • ✨ Use Github Action For Build And Deploy To Vercel
  • 🗻 Use Scalar For Docs API: /docs
  • 📦 Package Management With Bun Support
  • 🔗 Path Aliases
  • 🔒 Security: Helmet for HTTP header security and CORS setup
  • 👀 Logging: Efficient logging with pino, morgan and winston
  • 🔧 Environment Variables: Managed with Envalid
  • 🐱‍👓 Build With SWC
  • 🎡 Support Repository and Service
  • 🎮 Send log error use Telegram bot - use telegraf with error ETIMEDOUT (TODO fix)

Step-by-Step Guide

  • Install dependencies: bun install | npm ci | yarn
  • Environment Configuration:
    • Create .env: Copy .env.example to .env
    • Update .env: Fill in necessary environment variables
  • Running the Project:
    • Development Mode: bun dev | npm run dev | yarn dev
    • Building: bun run build | npm run build | yarn build