cotti/guestbooky
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Of course the README misses things.

Browse source
This commit is contained in:
Felipe Cotti 2024-10-04 19:47:12 -03:00
parent 4df16439bf
commit 37f94ed1db
1 changed files with 15 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -8,8 +8,8 @@
<div align="center"> <div align="center">
[![Status](https://img.shields.io/badge/status-active-success.svg)]() [![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/cotti/MessengerPlusSoundBankExtractor.svg)](https://github.com/cotti/MessengerPlusSoundBankExtractor/issues) [![GitHub Issues](https://img.shields.io/github/issues/cotti/guestbooky.svg)](https://github.com/cotti/guestbooky/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/cotti/MessengerPlusSoundBankExtractor.svg)](https://github.com/cotti/MessengerPlusSoundBankExtractor/pulls) [![GitHub Pull Requests](https://img.shields.io/github/issues-pr/cotti/guestbooky.svg)](https://github.com/cotti/guestbooky/pulls)
[![License](https://img.shields.io/badge/license-AGPLv3-003300.svg)](/LICENSE) [![License](https://img.shields.io/badge/license-AGPLv3-003300.svg)](/LICENSE)
</div> </div>
@ -23,12 +23,15 @@
## 📝 Table of Contents ## 📝 Table of Contents
- [About](#about)
- [Getting Started](#getting_started) - [📝 Table of Contents](#-table-of-contents)
- [Deployment](#deployment) - [🧐 About ](#-about-)
- [Usage](#usage) - [🏁 Getting Started ](#-getting-started-)
- [Built Using](#built_using) - [🕸️ Prerequisites](#️-prerequisites)
- [Authors](#authors) - [🎈 Usage ](#-usage-)
- [🚀 Deployment ](#-deployment-)
- [⛏️ Built Using ](#️-built-using-)
- [✍️ Authors ](#️-authors-)
## 🧐 About <a name = "about"></a> ## 🧐 About <a name = "about"></a>
@ -40,7 +43,7 @@ It includes many concepts that are very reasonable to tinker with as learning ma
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system. These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See [deployment](#deployment) for notes on how to deploy the project on a live system.
### Prerequisites ## 🕸️ Prerequisites
- .NET 8.0 - .NET 8.0
- A running instance of MongoDB - A running instance of MongoDB
@ -59,6 +62,7 @@ You will be able to see in `build/docker-compose.public.yml` that the applicatio
- CLOUDFLARE_SECRET=0x000000000000000000000000000000000 - CLOUDFLARE_SECRET=0x000000000000000000000000000000000
- MONGODB_CONNECTIONSTRING=mongodb://mongouser:mongopass@mongo:27017/Guestbooky - MONGODB_CONNECTIONSTRING=mongodb://mongouser:mongopass@mongo:27017/Guestbooky
- MONGODB_DATABASENAME=Guestbooky - MONGODB_DATABASENAME=Guestbooky
- LOG_LEVEL=Debug
``` ```
You will need to set them up either by hand or by using your IDE's capabilities. On Visual Studio, that can be done via the Debug Properties of Guestbooky.API. You will need to set them up either by hand or by using your IDE's capabilities. On Visual Studio, that can be done via the Debug Properties of Guestbooky.API.
@ -69,6 +73,8 @@ You will need to set them up either by hand or by using your IDE's capabilities.
**MONGODB_\*** -> Related to the connection to MongoDB. Yeah. **MONGODB_\*** -> Related to the connection to MongoDB. Yeah.
**LOG_\*** -> Logging.
## 🎈 Usage <a name="usage"></a> ## 🎈 Usage <a name="usage"></a>
For local usage of the backend, you can use `docker-compose.local.yml` and edit the fields you need. For local usage of the backend, you can use `docker-compose.local.yml` and edit the fields you need.