Bom dia, boa tarde ou boa noite. Esse projeto é um gerenciador do acervo da biblioteca da escola Etec Aristóteles Ferreira
Neste repositório vai existir três projetos:
- GIB (Gerenciador Interno da Biblioteca) usado pelos funcionários da biblioteca para gerenciar os livros e empréstimos.
- APB (Acervo Público da Biblioteca) usado pelos alunos para visualizar o acervo de livros contidos da biblioteca.
- API pública para professores proporem aos alunos a usarem, para testar chamadas HTTP e também popular sites feito por alunos.
- Docker: Para isolar os ambientes de teste
- .NET Core: Plataforma de todo o Back-End
- MySQL: Banco de Dados
- Entity Framework: ORM para conectar a aplicação ao banco de dados
- gRPC: Como protocolo de comunicação entre o servidor GIB e o cliente
- Blazor Hybrid + MAUI: Interface do cliente GIB
- xUnit: Para executar testes unitários das bibliotecas
- DocFx: Para criação da documentação
- Figma: Para prototipar o design
Atualmente está parcialmente completa a API interna do GIB feita em gRPC. É possível executar os testes unitários do projeto.
É possível executar a API de duas formas: usando o ambiente de máquina ou usando Docker. É preferível o uso do Docker caso já tenha instalado ou não consiga instalar os requisitos para a execução no ambiente de máquina.
Pode ser que, devido à velocidade de banda, demore para instalar as imagens e pacotes.
Para executar em ambiente local, há os seguintes requisitos:
- .NET 6.0.0
- MySQL
É necessário que antes da execução configurar o arquivo ./src/LivrEtec.GIB.Servidor/appsettings.json
Recomendo que copie o arquivo appsettings.modelo.json, preenchendo a propriedade AuthKey com uma string qualquer que sirva como chave de autenticação e a string de conexão de acordo com seu servidor MySQL. Use como exemplo o arquivo appsettings usado no docker.
Após configurar o projeto, você abrir o projeto no Visual Studio e escolher o LivrEtec.GIB.Servidor como projeto de iniciação, ou, executar num emulador de terminal no diretório ./src/LivrEtec.GIB.Servidor com o seguinte comando:
dotnet runPode ocorrer algum erro caso não tenha configurado o appsettings corretamente, como string de conexão ou porta inválida. Em caso de qualquer erro, sinta-se confortável para postar uma issue
Para executar o servidor usando Docker é simples, basta executar o seguinte comando na pasta ./src
docker compose --profile backend up --buildComo dito anteriormente,como é necessário baixar as imagens e pacotes NuGet pode demorar minutos para baixar dependendo da sua banda de internet.
Após executar o projeto, ele informará nas portas que está ouvindo. Como ainda não estão configurados certificados SSL, é recomendado usar padrões HTTP.
Para fazer as chamadas à API, escolha o cliente gRPC a sua escolha.
Algumas alternativas são o Insomnia ou o Postman.
O arquivo proto da api está em ./src/LivrEtec.GIB/Protos/acervo.proto.
Após isso, é necessário fazer login na API através de um request para login em GerenciamentoSessao. Para fazer o login são necessários o nome de login e o hash da senha, porém, na primeira vez iniciando o servidor, ele irá criar no banco de dados um usuário com login admin:senha e id 1.
O hash da senha precisa ser gerado da seguinte maneira:
md5(senha + id).
Então o request deve ficar da seguinte maneira:
{
"IdUsuario": 1,
"HashSenha": "92f20dafc5e5ac1c66820903c492cc04"
}E então ele retornará o token JWT, que deve ser adicionado a header da seguinte maneira:
Authorization: Bearer <JWT Token>
Pronto, agora você terá acesso ao resto da API como administrador.
Assim como a API do GIB é possível testar no ambiente local e no Docker, porém, é possível fazer alguns testes sem um servidor MySQL instalado.
Os testes são divididos em dois:
- Os testes locais que testam cada um dos serviços no próprio processo do teste usando SqlLite
- Testes remotos que são os testes de integração.
Para executar apenas os testes locais, basta ter instalado o .NET 6.0.0 e na pasta ./src/ executar o seguinte comando:
dotnet test LivrEtec.sln --filter Category=localCaso esteja usando Visual Studio abra o gerenciador de teste e execute a categoria de testes local
Para executar também testes remotos é necessário primeiro executar o servidor do GIB. Após ter executado, é necessário que crie e configure o arquivo ./src/LivrEtec.Testes/appsettings.json.
Copie o arquivo appsettings.modelo.json, e preencha com as mesma informações que preencheu o appsettings do servidor do GIB, além de adicionar o link do servidor, caso o link apareça neste formato:
http://[::]:21312significa o mesmo quehttp://localhost:21312
E após ter configurado o servidor e os testes para executar o projeto basta executar o seguinte comando no diretório ./src/
dotnet test LivrEtec.slnNo Visual Studio basta abrir o Gerenciador de Testes e clicar em executar.
Caso deseje usar o docker, apenas vá até a pasta ./src/ e execute os containers com o seguinte comando:
docker compose --profile teste up --buildO
--buildé para garantir que o container seja executado com o código mais recente.
Depois de executar os testes, o container do banco de dados irá continuar executando. Caso queira que saia automaticamente após os testes, adicione
--exit-code-from appcomo flag no comando.
O design está disponível em https://figma.com/community/file/1176031299741420547
Toda ajuda é bem vinda, caso queira colaborar. Recomendamos que primeiro vá na (Wiki)[./wiki/Arquitetura-dos-Projetos] e leia um pouco para ter a visão geral do projeto, e então procure nas (Issues)[./issues] qualquer problema que lhe interesse resolver. Se encontrar algum crie um fork do projeto, faça suas modificações e então faça um pull request para o projeto. Garanta que antes de fazer o pull request, tenha criado os testes para suas novas implementações, e de que esteja passando em todos os testes.
Para mais informações sobre o projeto, veja nossa documentação.
Seja bem-vindo :)