LivrEtec Download - LivrEtec Quellcode herunterladen

LivrEtec

Andere Kategorien

1.0.0

Herunterladen

Livetec

Guten Morgen, guten Nachmittag oder gute Nacht. Dieses Projekt ist Manager der ETEC Aristoteles Ferreira School Library Collection

Projekte

In diesem Repository gibt es drei Projekte:

GIB (Bibliothek Internal Manager), das von Bibliotheksmitarbeitern verwendet wird, um Bücher und Kredite zu verwalten.
APB (öffentliche Sammlung der Bibliothek), die von den Studenten verwendet wird, um die in der Bibliothek enthaltene Büchersammlung durch die Bibliothek anzuzeigen.
Die öffentliche API für Lehrer schlagen den Schülern vor, HTTP -Anrufe und auch beliebte Websites von Schülern zu testen.

Werkzeuge

Docker : Testumgebungen zu isolieren
.NET CORE : Plattform des gesamten Back Endes
MySQL : Datenbank
Entity Framework : ORM, um die Anwendung mit der Datenbank zu verbinden
GRPC : Als Kommunikationsprotokoll zwischen dem GIB -Server und dem Kunden
Blazor Hybrid + Maui : GIB -Kundenschnittstelle
Xunit : Durchführen von Bibliotheks -Unit -Tests durchführen
DOCFX : Zur Erstellung der Dokumentation
Figma : Prototypardesign

Wie man durchführt

Derzeit ist die interne GIB -API in GRPC teilweise abgeschlossen. Es ist möglich, die Unit -Tests des Projekts durchzuführen.

Laufen Gib API

Sie können die API auf zwei Arten ausführen: Verwenden der Maschinenumgebung oder Verwendung von Docker. Es ist vorzuziehen, Docker zu verwenden, wenn es bereits installiert wurde oder die Anforderungen für die Ausführung in der Maschinenumgebung nicht installieren kann.

Es kann sein, dass sich aufgrund der Bandbreite Zeit nimmt, um Bilder und Pakete zu installieren.

Laufen in einer lokalen Umgebung

Um in einer lokalen Umgebung auszuführen, gibt es folgende Anforderungen:

.NET 6.0.0
Mysql

Es ist notwendig, dass vor der Ausführung die Datei konfigurieren ./src/LivrEtec.GIB.Servidor/appsettings.json

Ich empfehle, die Datei appsettings.modelo.json zu kopieren und die Authaches -Eigenschaft mit einer Zeichenfolge zu füllen, die als Authentifizierungsschlüssel und die Verbindungszeichenfolge gemäß Ihrem MySQL -Server dient. Verwenden Sie als Beispiel die in Docker verwendete AppSettings -Datei.

Nach der Konfiguration des Projekts öffnen Sie das Projekt in Visual Studio und wählen den Livretec.gib.servator als Initiationsprojekt oder betreiben Sie auf einem Terminalemulator in der ./src/LivrEtec.GIB.Servidor

dotnet run

Es kann ein Fehler auftreten, wenn er Appsettings nicht korrekt konfiguriert hat, z. B. Verbindungszeichenfolge oder ungültiger Port. Fühlen Sie sich bei irgendeinem Fehler wohl, um eine zu veröffentlichen

Laufen mit Docker

Um den Server mit Docker auszuführen ist einfach, führen Sie einfach den folgenden Befehl im Ordner ./src aus

docker compose --profile backend up --build

Wie bereits erwähnt, kann die Herunterladen von Bildern und Paketen abhängig von Ihrer Internet -Band möglicherweise Minuten dauern, da Nuget heruntergeladen wird.

Berufung

Nachdem er das Projekt ausgeführt hat, wird er die Türen informieren, die er hört. Da SSL -Zertifikate noch nicht konfiguriert sind, wird empfohlen, HTTP -Standards zu verwenden.

Um die API zu tätigen, wählen Sie den GRPC -Kunden Ihre Wahl.

Einige Alternativen sind Schlaflosigkeit oder Postbote.

Die Proto -API -Datei ist unter ./src/livretec.gib/protos/acervo.proto.

Danach ist es notwendig, sich bei einer login in GerenciamentoSessao bei API anzumelden. Anmeldung ist erforderlich, um Anmeldung und Kennwort -Hash zu benennen. Wenn Sie jedoch den Server zum ersten Mal starten, wird ein Benutzer mit einem Benutzer mit admin:senha und id 1 erstellt.

Der Passwort -Hash muss wie folgt generiert werden: md5(senha + id) .

Die Anfrage sollte also wie folgt sein:

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

Und dann wird das JWT -Token zurückgegeben, das wie folgt zu Kopfzeilen hinzugefügt werden sollte: Authorization: Bearer <JWT Token>

Okay, jetzt haben Sie Zugriff auf den Rest der API als Administrator.

Durchführung der Tests

So wie die GIB -API in der lokalen Umgebung und Docker möglich ist, können Sie einige Tests ohne installierten MySQL -Server durchführen.

Lokale Umgebung

Die Tests sind in zwei unterteilt:

Lokale Tests, bei denen jedes der Dienste im Testprozess selbst mithilfe von SQLlite testen
Remote -Tests, die Integrationstests sind.

Um nur lokale Tests durchzuführen, haben Sie einfach den .NET 6.0.0 und im Ordner ./src/ den folgenden Befehl installiert:

dotnet test LivrEtec.sln --filter Category=local

Wenn Sie Visual Studio verwenden, öffnen Sie den Testmanager und führen Sie die local Testkategorie aus

Um auch Remote -Tests durchzuführen, müssen Sie zuerst den GIB -Server ausführen. Sobald Sie ausgeführt haben, müssen Sie die Datei ./src/LivrEtec.Testes/appsettings.json erstellen und konfigurieren.

Kopieren Sie die Datei appSettings.modelo.json und füllen Sie dieselben Informationen aus, die die http://[::]:21312 -Server -Appsettings gefüllt sowie den Server http://localhost:21312

Und nach dem Konfigurieren des Servers und der Tests, um das Projekt auszuführen, führen Sie einfach den folgenden Befehl im Verzeichnis ./src/ aus

dotnet test LivrEtec.sln

Öffnen Sie in Visual Studio einfach den Testmanager und klicken Sie auf Ausführen.

Docker

Wenn Sie den Docker verwenden möchten, gehen Sie einfach zum Ordner ./src/ und führen Sie die Container mit dem folgenden Befehl aus:

docker compose --profile teste up --build

Das --build soll sicherstellen, dass der Container mit dem neuesten Code ausgeführt wird.

Nach dem Ausführen der Tests wird der Datenbankcontainer weiter ausgeführt. Wenn Sie nach den Tests automatisch herauskommen möchten, fügen Sie --exit-code-from app als Flag im Befehl hinzu.

Design

Das Design ist unter https://figma.com/community/file/1176031299741420547 erhältlich

Wie man zusammenarbeitet

Alle Hilfe ist willkommen, wenn Sie zusammenarbeiten möchten. Wir empfehlen, dass Sie zuerst zu (Wiki) [./ Wiki/ Projects-of-Projects] gehen und ein wenig lesen, um den Projektüberblick zu erhalten, und dann nach (./ Problem] jedes Problem, das Sie interessiert. Wenn Sie eine Projektgabel finden, stellen Sie Ihre Änderungen vor und machen Sie dann einen Anziehungskraft für das Projekt. Stellen Sie sicher, dass Sie die Testanfragen erstellt haben.