generated from GabrielGuedess/NestJs-Boilerplate
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
18 additions
and
196 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -4,3 +4,4 @@ DATABASE_NAME=dibimbing | |
| DATABASE_USER=postgres | ||
| DATABASE_PASS=admin2024 | ||
| DATABASE_PORT=5434 | ||
| PORT=3001 | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,199 +1,20 @@ | ||
| <a name="readme-top"></a> | ||
| ## How to Run This Project | ||
|
|
||
| <h1 align="center"> | ||
| <br /> | ||
| <a href="#****" target="blank"> | ||
| <img src="https://nestjs.com/img/logo-small.svg" width="200" alt="Nest Logo"> | ||
| </a> | ||
| <br /> | ||
| 1. Run `pnpm install` to install all dependencies | ||
|
|
||
| NestJs Boilerplate | ||
| <br /> | ||
| 2. Run `pnpm setup:dev` to configure the docker | ||
|
|
||
| </h1> | ||
| You can also configure the Docker by changing the `.env.development` environment variable | ||
|
|
||
| <h4 align="center">A Better template with <a href="http://nestjs.com" target="_blank"><em>NestJs</em></a> with technologies to improve development.</h4> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://codecov.io/gh/GabrielGuedess/NestJs-Boilerplate"> | ||
| <img src="https://codecov.io/gh/GabrielGuedess/NetJs-Boilerplate/branch/master/graph/badge.svg?token=B7DKN82TEH"> | ||
| </a> | ||
|
|
||
| <a href="#"> | ||
| <img src="https://img.shields.io/github/license/GabrielGuedess/NestJs-Boilerplate"> | ||
| </a> | ||
|
|
||
| <a href="#"> | ||
| <img src="https://img.shields.io/github/actions/workflow/status/GabrielGuedess/NestJs-Boilerplate/ci.yml?label=CI"> | ||
| </a> | ||
|
|
||
| <a href="#"> | ||
| <img src="https://img.shields.io/github/languages/count/GabrielGuedess/NestJs-Boilerplate"> | ||
| </a> | ||
|
|
||
| <a href="#"> | ||
| <img src="https://img.shields.io/github/languages/top/GabrielGuedess/NestJs-Boilerplate"> | ||
| </a> | ||
|
|
||
| <a href="https://wakatime.com/badge/github/GabrielGuedess/NestJs-Boilerplate"> | ||
| <img src="https://wakatime.com/badge/github/GabrielGuedess/NestJs-Boilerplate.svg" alt="Wakatime"> | ||
| </a> | ||
| </p> | ||
|
|
||
| <p align="center"> | ||
| <a href="https://github.com/GabrielGuedess/NestJs-Boilerplate/issues">Report Bug</a> | ||
| · | ||
| <a href="https://github.com/GabrielGuedess/NestJs-Boilerplate/issues">Request Feature</a> | ||
| </p> | ||
|
|
||
|  | ||
|
|
||
| <!-- TABLE OF CONTENTS --> | ||
|
|
||
| <details> | ||
| <summary>Table of Contents</summary> | ||
| <ol> | ||
| <li> | ||
| <a href="#about-the-project">About The Project</a> | ||
| <ul> | ||
| <li><a href="#-built-with">Built With</a></li> | ||
| <li><a href="#-codecov">Codecov</a></li> | ||
| </ul> | ||
| </li> | ||
| <li> | ||
| <a href="#-getting-started">Getting Started</a> | ||
| <ul> | ||
| <li><a href="#prerequisites">Prerequisites</a></li> | ||
| <li><a href="#installation">Installation</a></li> | ||
| </ul> | ||
| </li> | ||
| <li><a href="#-configuration">Configuration</a></li> | ||
| <li><a href="#-contributing">Contributing</a></li> | ||
| <li><a href="#-license">License</a></li> | ||
| <li><a href="#-contact">Contact</a></li> | ||
| </ol> | ||
| </details> | ||
|
|
||
| ## About The Project | ||
|
|
||
| ### 🛠 Built With | ||
|
|
||
| The following tools were used in building the project: | ||
|
|
||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
| -  | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- Codecov --> | ||
|
|
||
| ### 🔍 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. | ||
|
|
||
| <br /> | ||
|
|
||
| <div align="center"> | ||
| <a href=""> | ||
| <img src="" /> | ||
| </a> | ||
| </div> | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- GETTING STARTED --> | ||
|
|
||
| ## 🚀 Getting Started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| To clone and run this application, you'll need _Git_ and _Docker_ installed on your computer. | ||
|
|
||
| ### Installation | ||
|
|
||
| ```sh | ||
| git clone https://github.com/GabrielGuedess/NestJs-Boilerplate | ||
| ```bash | ||
| DATABASE_URL= | ||
| DATABASE_NAME= | ||
| DATABASE_USER= | ||
| DATABASE_PASS= | ||
| DATABASE_PORT= | ||
| PORT= | ||
| ``` | ||
|
|
||
| 2. Go into the repository | ||
|
|
||
| ```sh | ||
| cd NestJs-Boilerplate | ||
| ``` | ||
|
|
||
| 3. Run Docker. | ||
|
|
||
| ```sh | ||
| docker-compose up -d | ||
| ``` | ||
|
|
||
| > **Note** | ||
| > If you're using Linux Bash for Windows, [see this guide](https://www.howtogeek.com/261575/how-to-run-graphical-linux-desktop-applications-from-windows-10s-bash-shell/) or use `node` from the command prompt. | ||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- ROADMAP --> | ||
|
|
||
| ## 🚨 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](https://github.com/GabrielGuedess/NestJs-Boilerplate/issues) for a full list of proposed features (and known issues). | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- CONTRIBUTING --> | ||
|
|
||
| ## 👏 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 | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- LICENSE --> | ||
|
|
||
| ## 📄 License | ||
|
|
||
| Distributed under the MIT License. See [MIT license](LICENSE) for more information. | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
|
|
||
| <!-- CONTACT --> | ||
|
|
||
| ## ⭐ Contact | ||
|
|
||
| Gabriel Guedes - [@GabrielRGuedess](https://twitter.com/GabrielRGuedess) - [email protected] | ||
|
|
||
| Project Link: [https://github.com/GabrielGuedess/NestJs-Boilerplate](https://github.com/GabrielGuedess/NestJs-Boilerplate) | ||
|
|
||
| --- | ||
|
|
||
| <p align="center"> | ||
| Made with ♥ by 👨🚀 Gabriel Guedes 👋 <a href="https://www.linkedin.com/in/gabriel-guedess/">Get in touch!</a> | ||
| </p> | ||
| 3. Run `pnpm migrate:dev` to configure the database | ||
|
|
||
| <p align="right">(<a href="#readme-top">back to top</a>)</p> | ||
| 4. Run `pnpm start:dev` to start the project |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,9 @@ | ||
| { | ||
| "name": "nestjs-boilerplate", | ||
| "name": "notes-app-backend", | ||
| "version": "1.0.5", | ||
| "description": "NestJS boilerplate", | ||
| "description": "Notes App Backend", | ||
| "license": "MIT", | ||
| "author": "Gabriel Guedes <[email protected]>", | ||
| "author": "Midyanisa Yuniar", | ||
| "scripts": { | ||
| "prebuild": "rimraf dist", | ||
| "build": "nest build", | ||
|
|
@@ -117,4 +117,4 @@ | |
| "engines": { | ||
| "node": ">=18.0.0" | ||
| } | ||
| } | ||
| } | ||