Skip to content

Node.js TypeScript Server Boilerplate: A scalable and maintainable boilerplate for building Node.js applications using TypeScript. It features essential tools like Express, ESLint, Prettier, Jest, and Mongoose, along with seamless environment management. Perfect for rapid development and adhering to best practices.

Notifications You must be signed in to change notification settings

adeelchainz/base_server

Repository files navigation

🚀 Node.js TypeScript Server Boilerplate

A lightweight boilerplate for building scalable Node.js applications using TypeScript. Perfect for rapid development and adhering to best practices!

🌟 Features

  • TypeScript: Strong typing for better code quality.
  • Express: Fast and minimalist web framework.
  • ESLint & Prettier: Maintain code quality and style.
  • Jest: Easy testing for reliability.
  • dotenv-flow: Manage environment variables effortlessly.
  • Mongoose: Simplified MongoDB interactions.
  • Winston: Comprehensive logging.

🚀 Getting Started

  1. Clone the repo:

    git clone https://github.com/yourusername/base_server.git
    cd base_server
  2. Install dependencies:

    npm install
  3. Set up environment files: Copy .env.example and configure.

  4. Start development:

    npm run start:dev

🛠️ Scripts

  • Build: npm run build - Compile TypeScript.
  • Test: npm run test - Run tests.
  • Lint: npm run lint - Check code for issues.
  • Fix Linting: npm run lint:fix - Automatically fix lint issues.
  • Format Check: npm run format:check - Check code formatting.
  • Fix Formatting: npm run format:fix - Automatically fix formatting.
  • Migrate Dev: npm run migrate:dev - Run development migrations.
  • Migrate Prod: npm run migrate:prod - Run production migrations.
  • Dockerize Dev: npm run dockerize:dev - Build Docker image for development.

🤝 Contributing

Contributions are welcome! Fork the repo and submit a pull request.

📜 License

MIT License

About

Node.js TypeScript Server Boilerplate: A scalable and maintainable boilerplate for building Node.js applications using TypeScript. It features essential tools like Express, ESLint, Prettier, Jest, and Mongoose, along with seamless environment management. Perfect for rapid development and adhering to best practices.

Resources

Stars

Watchers

Forks

Packages

No packages published