2023.1-Dnit-EscolaService

Serviço responsavel pelas funcionalidades relacionados as escolas (cadastro, busca, atualização e exclusão de escolas,e solicitações para ação do DNIT).

Como instalar

A forma de instalação é igual para todos os serviços, havendo diferenças apenas com base no sistema operacional.

Como instalar

A forma de instalação é igual para todos os serviços, havendo diferenças apenas com base no sistema operacional.

Observação: No EscolaServices, é necessario adicionar um arquivo ".env" dentro da pasta "app", com as seguintes informações:

- EMAIL_SERVICE_ADDRESS : email usado para enviar a mensagem.
- EMAIL_SERVICE_PASSWORD: senha do email acima.
- EMAIL_DNIT: email que receberá a mensagem.

Windows e MacOs

Modo 1

• Abra um navegador da web e acesse o site oficial da Microsoft .NET: https://dotnet.microsoft.com/download/dotnet/6.0
• Role a página até a seção ".NET 6 SDK" e clique no botão de download adequado para seu sistema operacional (por exemplo, "macOS x64 Installer" para macOS 64 bits ou "Windows x64 Installer" para Windows 64 bits).
• O arquivo de instalação será baixado. Depois que o download for concluído, clique duas vezes no arquivo para iniciá-lo.
• O instalador será aberto. Leia e aceite os termos de licença.
• Selecione as opções de instalação que você deseja.
• Clique no botão "Install" (Instalar) para iniciar a instalação do .NET 6.
• Após a conclusão da instalação, você verá uma tela informando que o .NET 6 SDK foi instalado com sucesso.
• Para verificar se a instalação foi bem-sucedida, abra o Prompt de Comando ou o PowerShell e execute o seguinte comando:

dotnet --version

• Isso exibirá a versão do .NET instalada, confirmando se o .NET 6 está configurado corretamente.

Modo 2

Basta instalar a IDE Visual Studio escolhendo a versão gratuita (Versão Community). Após instalar o Visual Studio, ele automaticamente irá instalar o .NET com a versão mais estável.

Linux

Instale o SDK do *.*NET .

sudo apt-get update && \
  sudo apt-get install -y dotnet-sdk-6.0

Instale o runtime ASP.NET Core.

sudo apt-get update && \
  sudo apt-get install -y aspnetcore-runtime-6.0

Entre na pasta do serviço. Dentro da pasta "app" rode o comando:

dotnet run

Clonar Aplicação

Para clonar o repostório, basta utilizar o comando abaixo:

EscolaService

git clone https://github.com/fga-eps-mds/2023.1-Dnit-EscolaService.git

Como Rodar

Utilizando docker-compose

Pré-requisitos

• Docker
• Docker-compose

Windows

Rode o seguinte comando na pasta da aplicação.

docker-compose build && docker-compose up

Linux ou MacOS

Rode o seguinte comando na pasta da aplicação.

sudo docker-compose build && sudo docker-compose up

Usando Visual Studio

Para rodar uma aplicação usando Visual Studio, basta clicar no arquivo com extenção 'sln' e em seguida clicar no ícone para rodar aplicação conforme mostra abaixo:

Usando Visual Studio Code

Para rodar utilizando o VS Code, basta seguir a seguinte instrução:

Entre na pasta do serviço. Dentro da pasta "app" rode o comando:

dotnet run

Encerrando a aplicação

No terminal em que a aplicação esta rodando, digite simultaneamente as teclas ctrl+c. Caso esteja utilizando o Visual Studio, clique no ícone quadrado vermelho

Documentação endpoints

Para documentar os endpoints estamos utilizando o Swagger. Caso queira visualizar, basta abrir a rota:

http://localhost:7084/swagger/index.html

Licença

O projeto DnitEscolaService está sob as regras aplicadas na licença AGPL-3.0

Contribuidores