Skip to content

rifkiandriyanto/nodejs-typescript-minimal

Repository files navigation

🚀 Node.js TypeScript Minimal Boilerplate

GitHub stars GitHub license

🎯 Overview

A lightweight yet powerful Node.js TypeScript boilerplate designed for building scalable backend applications. This template combines modern development practices with essential tools, striking the perfect balance between functionality and simplicity.

🎨 Philosophy

Built with three core principles:

  • 🎯 Minimalism: Only essential features, no bloat
  • Performance: Optimized for speed and efficiency
  • 🛠️ Developer Experience: Intuitive setup and workflow

✨ Key Features

Development Tools

  • 🔄 Modern Runtime: Lightning-fast TypeScript execution with tsx
  • 📁 Clean Architecture: Feature-based structure for optimal organization
  • 🔗 Enhanced Imports: Streamlined development with path aliases
  • 🌐 Version Control: LTS Node.js version management via .nvmrc

Security & Quality

  • 🛡️ Enterprise Security: Built-in Helmet and CORS protection
  • ⚙️ Config Management: Type-safe environment variables with Envalid
  • 📊 Logging System: Production-ready logging with pino-http
  • Code Quality: Automated checks with Husky and lint-staged

Testing & Documentation

  • 🧪 Testing Suite: Comprehensive setup with Vitest and Supertest
  • 📝 API Validation: Type-safe requests using Zod
  • 🔍 API Docs: Auto-generated Swagger UI
  • 🐳 Deployment Ready: Docker support included

🚀 Quick Start

Installation

# Clone repository
git clone https://github.com/rifkiandriyanto/nodejs-typescript-minimal.git

# Navigate to project
cd nodejs-typescript-minimal

# Install dependencies
pnpm install

# Setup environment
cp .env.example .env

# Start development server
pnpm dev

Available Scripts

pnpm dev      # Start development server
pnpm build    # Build for production
pnpm start    # Run production build
pnpm test     # Run tests

🤝 Contributing

Contributions are welcome! Feel free to:

  • Submit issues
  • Fork the repository
  • Create pull requests

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.


Happy Coding! 🎉

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published