LivrEtec

Livetec

Bonjour, bon après-midi ou bonne nuit. Ce projet est un gestionnaire de la collection de bibliothèque scolaire Etec Aristotle Ferreira

Projets

Dans ce référentiel, il y aura trois projets:

• GIB (Bibliothèque Interne Manager) utilisé par les employés de la bibliothèque pour gérer les livres et les prêts.
• APB (collection publique de la bibliothèque) utilisée par les étudiants pour consulter la collection de livres de la bibliothèque contenue dans la bibliothèque.
• L'API publique pour les enseignants propose aux étudiants d'utiliser, de tester les appels HTTP et également des sites populaires fabriqués par les étudiants.

Outils

• Docker : pour isoler les environnements de test
• .NET Core : plate-forme de toute la back-end
• MySQL : base de données
• Framework de l'entité : ORM pour connecter l'application à la base de données
• GRPC : En tant que protocole de communication entre le serveur GIB et le client
• Blazor Hybrid + Maui : Interface client GIB
• Xunit : pour effectuer des tests d'unité de bibliothèque
• Docfx : pour la création de documentation
• Figma : Conception du prototypte

Comment jouer

Actuellement, est partiellement complet de l'API interne GIB fabriquée en GRPC. Il est possible d'effectuer les tests unitaires du projet.

API GIB en cours d'exécution

Vous pouvez exécuter l'API de deux manières: utiliser l'environnement de la machine ou utiliser Docker. Il est préférable d'utiliser Docker s'il a déjà installé ou n'est pas en mesure d'installer les exigences d'exécution dans l'environnement de la machine.

Il se peut que, en raison de la bande passante, prenne du temps pour installer des images et des packages.

Courir dans un environnement local

Pour exécuter dans un environnement local, il existe les exigences suivantes:

• .Net 6.0.0
• Mysql

Il est nécessaire qu'avant l'exécution, configurez le fichier ./src/LivrEtec.GIB.Servidor/appsettings.json

Je recommande de copier le fichier AppSettings.modelo.json, remplissant la propriété Authkey avec une chaîne qui sert de clé d'authentification et de la chaîne de connexion en fonction de votre serveur MySQL. Utilisez comme exemple le fichier AppSettings utilisé dans Docker.

Après avoir configuré le projet, vous ouvrez le projet dans Visual Studio et choisissez le Livretec.gib.Servator comme projet d'initiation, ou exécutez un émulateur de terminal dans le ./src/LivrEtec.GIB.Servidor

dotnet run

Une erreur peut se produire si elle n'a pas configuré les appsettings correctement, tels que la chaîne de connexion ou le port non valide. En cas d'erreur, n'hésitez pas à publier un

Courir à l'aide de Docker

Pour exécuter le serveur à l'aide de Docker est simple, il suffit d'exécuter la commande suivante dans le dossier ./src

docker compose --profile backend up --build

Comme indiqué précédemment, il est nécessaire de télécharger les images et les packages que Nuget peut prendre quelques minutes à télécharger en fonction de votre bande Internet.

Appel

Après avoir exécuté le projet, il informera les portes qu'il écoute. Comme les certificats SSL ne sont pas encore configurés, il est recommandé d'utiliser les normes HTTP.

Pour passer des appels à l'API, choisissez le client GRPC votre choix.

Certaines alternatives sont l'insomnie ou le facteur.

Le fichier API Proto est sur ./src/livretec.gib/protos/acervo.proto.

Après cela, il est nécessaire de se connecter à l'API via une demande de login dans GerenciamentoSessao . La connexion est nécessaire pour nommer la connexion et le hachage de mot de passe, mais la première fois en démarrant le serveur, il créera un utilisateur avec un utilisateur avec admin:senha et id 1.

Le hachage du mot de passe doit être généré comme suit: md5(senha + id) .

La demande doit donc être la suivante:

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

Et puis il renverra le jeton JWT, qui devrait être ajouté à l'en-tête comme suit: Authorization: Bearer <JWT Token>

D'accord, vous aurez maintenant accès au reste de l'API en tant qu'administrateur.

Effectuer les tests

Tout comme l'API GIB est possible pour tester dans l'environnement local et Docker, vous pouvez faire des tests sans serveur MySQL installé.

Environnement local

Les tests sont divisés en deux:

• Tests locaux qui testent chacun des services du processus de test lui-même à l'aide de Sqllite
• Tests distants qui sont des tests d'intégration.

Pour effectuer uniquement des tests locaux, j'ai simplement installé le .NET 6.0.0 et dans le dossier ./src/ Effectuez la commande suivante:

dotnet test LivrEtec.sln --filter Category=local

Si vous utilisez Visual Studio, ouvrez le gestionnaire de test et exécutez la catégorie de test local

Pour effectuer également des tests distants, vous devez d'abord exécuter le serveur GIB. Une fois que vous avez exécuté, vous devez créer et configurer le fichier ./src/LivrEtec.Testes/appsettings.json .

Copiez le fichier AppSettings.modelo.json et remplissez les mêmes informations qui ont rempli les appsettings Gib Server, ainsi que l'ajout du lien du serveur, si le lien apparaît dans ce format: http://[::]:21312 signifie la même chose que http://localhost:21312

Et après avoir configuré le serveur et les tests pour exécuter le projet, exécutez simplement la commande suivante dans le répertoire ./src/

dotnet test LivrEtec.sln

Dans Visual Studio, ouvrez simplement le gestionnaire de test et cliquez sur Exécuter.

Docker

Si vous souhaitez utiliser le docker, accédez simplement au dossier ./src/ et exécutez les conteneurs avec la commande suivante:

docker compose --profile teste up --build

Le --build doit s'assurer que le conteneur est exécuté avec le dernier code.

Après avoir exécuté les tests, le conteneur de la base de données continuera à s'exécuter. Si vous souhaitez sortir automatiquement après les tests, ajoutez --exit-code-from app en tant que drapeau dans la commande.

Conception

La conception est disponible sur https://figma.com/community/file/1176031299741420547

Comment collaborer

Toute aide est la bienvenue si vous souhaitez collaborer. Nous vous recommandons d'abord d'aller sur (wiki) [./ wiki / projects-of-projects] et de lire un peu pour obtenir l'aperçu du projet, puis rechercher (./.

Documentation

Pour plus d'informations sur le projet, consultez notre documentation.

Accueillir :)