Hearth is a minimal yet powerful backend template built with NestJS. It provides a structured foundation for building scalable and maintainable server-side applications. The template includes pre-configured tooling like ESLint, Prettier, Husky, and Commitlint to ensure a smooth development experience and maintain consistent code quality.
- NestJS: A progressive Node.js framework for scalable applications.
- TypeScript: Static typing for better code reliability and maintainability.
- Pre-configured Tooling:
- ESLint: Identify and fix linting issues.
- Prettier: Opinionated code formatting.
- 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.
- Developer Experience: Optimized setup for efficient backend development.
- Environment Configuration: An example
.envfile has been added for reference.
Ensure you have the following installed:
- Node.js: v22 or later.
-
Clone the repository:
git clone https://github.com/tejastn10/hearth.git cd hearth -
Install dependencies:
npm install
-
Start the development server:
npm run dev
-
Your server is now running at
http://localhost:5000. -
To access Swagger API Docs open
http://localhost:5000/docs.
This project is licensed under the MIT License. See the LICENSE file for details.
- 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.