NestJs Boilerplate

A Better template with NestJs with technologies to improve development.

Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
   • Codecov
2. Getting Started
   • Prerequisites
   • Installation
3. Configuration
4. Contributing
5. License
6. Contact

About The Project

🛠 Built With

The following tools were used in building the project:

• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 
• 

(back to top)

🔍 Codecov

Codecov provides metrics and insights into the results of tests through code coverage reports. Coverage reports are used to determine which lines of code were tested and which lines were not tested, which may contain bugs and syntax errors.

(back to top)

🚀 Getting Started

Prerequisites

To clone and run this application, you'll need Git and Docker installed on your computer.

Installation

git clone https://github.com/GabrielGuedess/NestJs-Boilerplate

2. Go into the repository

cd NestJs-Boilerplate

3. Run Docker.

docker-compose up -d

Note If you're using Linux Bash for Windows, see this guide or use node from the command prompt.

(back to top)

🚨 Configuration

• Prisma
  • Add DATABASE_URL to .env.
• Docker Compose
  • Add POSTGRES_DB to .env.
  • Add POSTGRES_USER to .env.
  • Add POSTGRES_PASSWORD to .env.

See the open issues for a full list of proposed features (and known issues).

(back to top)

👏 Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/NewFeature)
3. Commit your Changes (git commit -m 'Add some NewFeature')
4. Push to the Branch (git push origin feature/NewFeature)
5. Open a Pull Request

(back to top)

📄 License

Distributed under the MIT License. See MIT license for more information.

(back to top)

⭐ Contact

Gabriel Guedes - @GabrielRGuedess - [email protected]

Project Link: https://github.com/GabrielGuedess/NestJs-Boilerplate

---

Made with ♥ by 👨‍🚀 Gabriel Guedes 👋 Get in touch!

(back to top)