LivrEtec

Livetec

Buenos días, buenas tardes o buenas noches. Este proyecto es gerente de la colección de biblioteca de la escuela Etec Aristotle Ferreira

Proyectos

En este repositorio habrá tres proyectos:

• GIB (gerente interno de la biblioteca) utilizado por los empleados de la biblioteca para administrar libros y préstamos.
• APB (Colección pública de la biblioteca) utilizada por los estudiantes para ver la colección de libros de la biblioteca contenida en la biblioteca.
• La API pública para los maestros propone que los estudiantes usen, para evaluar las llamadas HTTP y también los sitios populares hechos por los estudiantes.

Herramientas

• Docker : aislar ambientes de prueba
• .NET Core : plataforma de todo el back -end
• Mysql : base de datos
• Entity Framework : ORM para conectar la aplicación a la base de datos
• GRPC : como protocolo de comunicación entre el servidor GIB y el cliente
• Blazor Hybrid + Maui : interfaz de cliente GIB
• XUnit : realizar pruebas unitarias de la biblioteca
• Docfx : para la creación de documentación
• Figma : para el diseño de prototipar

Cómo realizar

Actualmente se completa parcialmente la API interna GIB realizada en GRPC. Es posible realizar las pruebas unitarias del proyecto.

Running GIB API

Puede ejecutar la API de dos maneras: usar el entorno de la máquina o usar Docker. Es preferible usar Docker si ya ha instalado o no puede instalar los requisitos para la ejecución en el entorno de la máquina.

Puede ser que, debido al ancho de banda, tome tiempo para instalar imágenes y paquetes.

Corriendo en un entorno local

Para ejecutar en un entorno local, existen los siguientes requisitos:

• .NET 6.0.0
• Mysql

Es necesario que antes de la ejecución configure el archivo ./src/LivrEtec.GIB.Servidor/appsettings.json

Recomiendo copiar el archivo appSettings.modelo.json, llenando la propiedad AuthKey con una cadena que sirve como clave de autenticación y la cadena de conexión de acuerdo con su servidor MySQL. Use como ejemplo, el archivo AppSettings utilizado en Docker.

Después de configurar el proyecto, abre el proyecto en Visual Studio y elija el Livretec.gib.servator como un proyecto de iniciación, o se ejecute en un emulador terminal en el ./src/LivrEtec.GIB.Servidor

dotnet run

Puede ocurrir un error si no ha configurado las appSettings correctamente, como la cadena de conexión o el puerto no válido. En caso de cualquier error, siéntete cómodo para publicar un

Ejecutando usando Docker

Para ejecutar el servidor usando Docker es simple, simplemente ejecute el siguiente comando en la carpeta ./src

docker compose --profile backend up --build

Como se dijo anteriormente, ya que es necesario descargar las imágenes y los paquetes que Nuget puede tardar minutos en descargar dependiendo de su banda de Internet.

Vocación

Después de ejecutar el proyecto, informará a las puertas que está escuchando. Como los certificados SSL aún no están configurados, se recomienda utilizar los estándares HTTP.

Para hacer llamadas a la API, elija el cliente de GRPC su elección.

Algunas alternativas son el insomnio o el postman.

El archivo API de Proto es en ./src/livretec.gib/protos/acervo.proto.

Después de eso, es necesario iniciar sesión en API a través de una solicitud de login en GerenciamentoSessao . Se requiere inicio de sesión para nombrar el hash de inicio de sesión y contraseña, pero la primera vez que inicia el servidor, creará un usuario con un usuario con admin:senha e id 1.

El hash de contraseña debe generarse de la siguiente manera: md5(senha + id) .

Entonces la solicitud debe ser la siguiente:

{
	"IdUsuario" : 1 ,
	"HashSenha" : " 92f20dafc5e5ac1c66820903c492cc04 "
}

Y luego devolverá el token JWT, que debe agregarse al encabezado de la siguiente manera: Authorization: Bearer <JWT Token>

Bien, ahora tendrá acceso al resto de la API como administrador.

Realizando las pruebas

Sin embargo, tal como es posible probar la API GIB en el entorno local y el Docker, puede hacer algunas pruebas sin un servidor MySQL instalado.

Entorno local

Las pruebas se dividen en dos:

• Pruebas locales que prueban cada uno de los servicios en el proceso de prueba en sí mismo utilizando SQLLITE
• Pruebas remotas que son pruebas de integración.

Para realizar solo pruebas locales, simplemente haya instalado el .NET 6.0.0 y en la carpeta ./src/ Realice el siguiente comando:

dotnet test LivrEtec.sln --filter Category=local

Si está utilizando Visual Studio, abra el administrador de pruebas y ejecute la categoría de prueba local

Para realizar pruebas remotas también debe ejecutar el servidor GIB. Una vez que haya ejecutado, debe crear y configurar el archivo ./src/LivrEtec.Testes/appsettings.json .

Copie el archivo appSettings.modelo.json y complete con la misma información que llenó las appsettings del servidor GIB, además de agregar el enlace del servidor, si el enlace aparece en este formato: http://[::]:21312 significa lo mismo que http://localhost:21312

Y después de configurar el servidor y las pruebas para ejecutar el proyecto, simplemente ejecute el siguiente comando en el directorio ./src/

dotnet test LivrEtec.sln

En Visual Studio, simplemente abra el administrador de pruebas y haga clic en Ejecutar.

Estibador

Si desea usar el Docker, simplemente vaya a la carpeta ./src/ y ejecute los contenedores con el siguiente comando:

docker compose --profile teste up --build

El --build es para asegurarse de que el contenedor se ejecute con el último código.

Después de ejecutar las pruebas, el contenedor de la base de datos continuará ejecutándose. Si desea salir automáticamente después de las pruebas, agregue --exit-code-from app como un indicador en el comando.

Diseño

El diseño está disponible en https://figma.com/community/file/1176031299741420547

Cómo colaborar

Toda la ayuda es bienvenida si desea colaborar. Recomendamos que primero vaya a (wiki) [./ wiki/ proyectos de proyectos] y lea un poco para obtener la descripción general del proyecto, y luego busque (./ problemas] cualquier problema que le interese. Si encuentra un bifurcación de proyecto, realiza sus modificaciones y luego realiza una extracción para el proyecto.

Documentación

Para obtener más información sobre el proyecto, consulte nuestra documentación.

Bienvenido :)