BackendKickstarter

Overview

BackendKickstarter is a minimalistic starter template for building backend applications using TypeScript and Express. It provides a solid foundation with core features, best practices, and tools to help you kickstart your backend development quickly and efficiently.

Features

• Core Structure: Organized folder structure for API controllers, models, services, and utilities.
• TypeScript Support: Full TypeScript support for type safety and enhanced developer experience.
• API Documentation: Automatically generated OpenAPI documentation using Swagger.
• Validation: Input validation using class-validator and Zod.
• Logging: Integrated logging with Pino for improved debugging.
• Task Automation: Use Listr for prettified task lists and easy command execution.
• CLI Interaction: Gather user input using Inquirer for customizable project setup.
• Testing: Unit testing setup using Vitest.
• Linting and Formatting: Code quality checks with Biome.

Installation

You can install BackendKickstarter using npx:

npx backend-kickstarter

Usage

Once you have installed the template, navigate to your project directory and run the following commands to start developing your backend application:

# Install dependencies
pnpm install

# Run the development server
pnpm run dev

Project Structure

Copy code
├── src
│   ├── api
│   ├── api-docs
│   ├── common
│   ├── index.ts
│   ├── server.ts
├── .env
├── .gitignore
├── package.json
├── pnpm-lock.yaml
├── tsconfig.json
└── vite.config.mts

Contributing

We welcome contributions to BackendKickstarter! Please read our CONTRIBUTING.md for details on how to get involved.

License

This project is licensed under the MIT License. See the LICENSE.md file for more details.

Changelog

See the CHANGELOG.md for a detailed list of changes and updates.

Contact

For questions or support, please contact Akinwole Adeola at [[email protected]].