https://github.com/tejastn10/hearth

A minimal and scalable NestJS starter template with ESLint, Prettier, Husky, and Commitlint preconfigured for clean and efficient backend development.
https://github.com/tejastn10/hearth

docker fastify nestjs swagger typescript

Last synced: 2 months ago
JSON representation

A minimal and scalable NestJS starter template with ESLint, Prettier, Husky, and Commitlint preconfigured for clean and efficient backend development.

• Host: GitHub
• URL: https://github.com/tejastn10/hearth
• Owner: tejastn10
• License: mit
• Created: 2025-02-09T10:21:07.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2026-01-21T16:34:18.000Z (5 months ago)
• Last Synced: 2026-01-22T04:26:15.768Z (5 months ago)
• Topics: docker, fastify, nestjs, swagger, typescript
• Language: TypeScript
• Homepage:
• Size: 2.54 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          


  



# Hearth 🔥

![Node.js Version](https://img.shields.io/badge/Node.js-22%2B-339933?logo=nodedotjs&logoColor=white)

![TypeScript](https://img.shields.io/badge/TypeScript-5%2B-007ACC?logo=typescript&logoColor=white)

![NestJS](https://img.shields.io/badge/NestJS-11%2B-E0234E?logo=nestjs&logoColor=white)

![License](https://img.shields.io/badge/License-MIT-yellow?logo=open-source-initiative&logoColor=white)

**Hearth** is a minimal yet powerful backend template built with [NestJS](https://nestjs.com/). It provides a structured foundation for building scalable and maintainable server-side applications. The template includes pre-configured tooling like Biome, Husky, and Commitlint to ensure a smooth development experience and maintain consistent code quality.

---

## Features ⚡

- **NestJS**: A progressive Node.js framework for scalable applications.

- **TypeScript**: Static typing for better code reliability and maintainability.

- **Pre-configured Tooling**:

  - **BiomeJS**: Enforces consistent code quality.

  - **Husky**: Pre-commit hooks for enforcing best practices.

  - **Commitlint**: Enforce consistent commit message formatting.

- **Modular Architecture**: Designed for scalability and maintainability.

- **Swagger API Documentation**:

  - Built-in OpenAPI (Swagger) integration for easy API exploration.

- **Database Support**:

  - **PostgreSQL**: Integrated with TypeORM for relational database needs.

  - **MongoDB**: Uses Mongoose ODM for handling NoSQL collections.

- **Redis Cache**: Integrated Redis service for caching and performance optimization.

- **Developer Experience**: Optimized setup for efficient backend development.

- **Environment Configuration**: An example `.env` file has been added for reference.

---

## Getting Started 🚀

### Prerequisites

Ensure you have the following installed:

- **Node.js**: v22 or later.

---

### Installation ⚙️

1. Clone the repository:

   ```bash

   git clone https://github.com/tejastn10/hearth.git

   cd hearth

   ```

2. Install dependencies:

   ```bash

   npm install

   ```

3. Start the development server:

   ```bash

   npm run dev

   ```

4. Your server is now running at `http://localhost:5000`.

5. To access Swagger API Docs open `http://localhost:5000/docs`.

---

## License 📜

This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

---

## Acknowledgments 🙌

- Built with **NestJS** for a structured and scalable backend foundation.

- Inspired by the warmth of **Hearth**, providing a solid starting point for backend projects.

- Made with ❤️ for developers who value clean and efficient backend architectures.