From eb6e690648b4c7d548e3fd614d272bf030ef0e6b Mon Sep 17 00:00:00 2001 From: Eduardo_Kroetz <146035630+EduardoKroetz@users.noreply.github.com> Date: Wed, 26 Jun 2024 21:46:34 -0300 Subject: [PATCH] Update README.md --- README.md | 58 +++++++++++++++++++++++++++++++------------------------ 1 file changed, 33 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index 8aa96cb..6a9f0a6 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,54 @@ -

API de Sistema de hotel

+

API de Sistema de Hotel

-![MicrosoftSQLServer](https://img.shields.io/badge/Microsoft%20SQL%20Server-CC2927?style=for-the-badge&logo=microsoft%20sql%20server&logoColor=white) -![.Net](https://img.shields.io/badge/.NET-5C2D91?style=for-the-badge&logo=.net&logoColor=white) -![C#](https://img.shields.io/badge/c%23-%23239120.svg?style=for-the-badge&logo=csharp&logoColor=white) +[MicrosoftSQLServer]: https://img.shields.io/badge/Microsoft%20SQL%20Server-CC2927?style=for-the-badge&logo=microsoft%20sql%20server&logoColor=white +[.Net]: https://img.shields.io/badge/.NET-5C2D91?style=for-the-badge&logo=.net&logoColor=white +[C#]: https://img.shields.io/badge/c%23-%23239120.svg?style=for-the-badge&logo=csharp&logoColor=white + + +![MicrosoftSQLServer] +![.Net] +![C#]

- Getting Started • + 🚀 Getting Started •

-

A API de sistema de hotel facilita a integração e permite realizar operações típicas de hospedagem. Ela permite realizar operações como gestão de reservas, cômodos, funcionários, clientes, relatórios e mais.

- -

🚀 Getting started

+

🚀 Getting Started

Prerequisites

-

Os seguintes pré-requisitos são necessários para executar o projeto

- -- [.NET 8](https://dotnet.microsoft.com/pt-br/) -- [Git 2](https://github.com) - +

Os seguintes pré-requisitos são necessários para executar o projeto:

+

Cloning

-

Para clonar o projeto, basta executar o seguinte comando no terminal

+

Para clonar o projeto, basta executar o seguinte comando no terminal:

```bash git clone https://github.com/EduardoKroetz/HotelSistem.git ``` -

Environment Variables

-

Adicione essas variáveis de ambiente em um arquivo appsettings.json

- -```yaml -EmailToSendEmail={seu_email_para_enviar_emails} -PasswordToSendEmail={sua_senha_para_enviar_emails} -JwtKey=addakaDfAyrtcvnncvAEreaxxvrtkkadAeretGAc -ConnectionStrings:DefaultConnection={sua_conexão_com_o_sql_server} -Stripe:SecretKey={sua_chave_secreta_do_stripe} -Stripe:PublishableKey={sua_chave_pública_do_stripe} +

Environment Variables

+

Adicione essas variáveis de ambiente em um arquivo appsettings.json:

+ +```json + "EmailToSendEmail":"seu_email_para_enviar_emails" + "PasswordToSendEmail":"sua_senha_para_enviar_emails" + "JwtKey":"addakaDfAyrtcvnncvAEreaxxvrtkkadAeretGAc" + "ConnectionStrings": { + "DefaultConnection":"sua_conexão_com_o_sql_server" + } + "Stripe": { + "SecretKey":"sua_chave_secreta_do_stripe" + "PublishableKey":"sua_chave_pública_do_stripe" + } ``` +

Observação: As chaves do Stripe são necessárias para a integração com o sistema de pagamento Stripe. Caso ainda não tenha uma conta no Stripe, você pode criar uma conta de teste aqui.

Starting

-

Para iniciar o projeto, execute

+

Para iniciar o projeto, execute os seguintes comandos:

```bash cd HotelSistem/Hotel.Domain