LawKnowledge

Erste Schritte

Voraussetzungen

Infrastruktur

• NX - NX ist ein Satz erweiterbarer Entwicklerwerkzeuge für Monorepos.
• NODEJS - NODE.JS® ist eine JavaScript -Laufzeit, die auf Chrome's V8 JavaScript -Engine basiert.
• PNPM - Schneller, Space Space Efficient Package Manager.
• Python - Python ist eine Programmiersprache, mit der Sie schnell arbeiten und Systeme effektiver integrieren können.
• Poesie - Poesie hilft Ihnen, Abhängigkeiten von Python -Projekten zu deklarieren, zu verwalten und zu installieren und sicherzustellen, dass Sie überall den richtigen Stapel haben.
• Pulumi - Pulumi ist eine Infrastruktur, Geheimnisse und Konfigurationen intuitiv in jeder Cloud.
• Docker (Kubernetes aktiviert) - Docker ist eine offene Plattform zum Entwickeln, Versand und Ausführen von Anwendungen.
• Helm - Helm ist der beste Weg, um Software zu finden, zu teilen und zu verwenden, die für Kubernetes erstellt wurden.

Dienstleistungen

• AWS - Ein Amazon Web Services -Konto ist erforderlich, um die Infrastruktur bereitzustellen.
• Suggingface - Ein Umarmungsface -Konto ist erforderlich, um das Datensatz und das Modell herunterzuladen und hochzuladen.

? Ressourcen umarmen

Sie können den Datensatz aus dem folgenden Link herunterladen:

• Rechtswissendaten: Der Datensatz von Pháp điển und Văn Bản Pháp Luật.
• Rechtswissenmodell: Ein fein abgestimmtes Modell von Phobert.

?aufstellen

Klonen Sie zunächst das Repository in Ihre lokale Maschine:

git clone https://github.com/foxminchan/LawKnowledge

Navigieren Sie als Nächstes zum Stammverzeichnis des Projekts und installieren Sie die Abhängigkeiten:

pnpm install --force

Läuft

Für die Website können Sie den folgenden Befehl ausführen:

npx nx serve website --prod

Für die API können Sie den folgenden Befehl ausführen:

 # For the API Gateway
npx nx serve api-gateway --prod

# For the Auth Service
npx nx serve auth-svc --prod

# For the Law Service
npx nx serve law-svc --prod

# For the Search Service, navigate to the search-svc directory
npx nx build search-svc && cd apps/api/search-svc/search-svc && python main.py

# For the Chat Service, navigate to the chat-svc directory
npx nx build chat-svc && cd apps/api/chat-svc/chat-svc && python main.py

Um das Modell zu transen, können Sie den folgenden Befehl ausführen:

npx nx build bert && cd apps/nlp/bert/bert && python main.py

Um die Infrastruktur einzurichten, können Sie den folgenden Befehl ausführen:

npx nx up pulumi

Wichtig

Wenn Sie mit NX ausführen möchten, stellen Sie sicher, dass Sie "Poesie" global installiert haben. Die Python -Version muss `> = 3.9.1 <= 3.12` sein.

? Testen

Für die Website können Sie den folgenden Befehl ausführen:

npx nx test website-e2e

Für die API können Sie den folgenden Befehl ausführen:

 # For the Auth Service
npx nx test auth-svc-e2e

# For the Law Service
npx nx test law-svc-e2e

# For the Search Service
npx nx test search-svc-e2e

# For the Chat Service
npx nx test chat-svc

Um das Modell zu testen, können Sie den folgenden Befehl ausführen:

npx nx test bert

? Andere

Um das Tooling zur Verarbeitung des Datensatzes auszuführen, können Sie den folgenden Befehl ausführen:

npx nx build processor && cd apps/nlp/processor/processor && python main.py

Für die Ausführung der Dokumentation können Sie den folgenden Befehl ausführen:

npx nx serve docs

Für das Ausführen des Diagramms als Code können Sie den folgenden Befehl ausführen:

npx nx build dac && cd assets/dac/dac && python main.py

Einige nützliche Skripte:

 # Navigate to the scripts directory
cd tools/scripts && ls

# + scripts
# +-- build.sh --> Build the project
# +-- clean.sh --> Clean the docker image
# +-- init.sh --> Initialize the project
# +-- prepare.sh --> Prepare the project
# +-- start.sh --> Start the project
# +-- start-o11y.sh --> Start the observability stack
# +-- stop-o11y.sh --> Stop the observability stack

# Run the script
./ < script-name >

Abhängigkeitsgrafik

Sie können das Abhängigkeitsgraphen des Projekts sehen, indem Sie den folgenden Befehl ausführen:

npx nx dep-graph

Hier ist die Abhängigkeitsgrafik des Projekts:

Beitragen

Richtlinien beitragen

Wir freuen uns, dass Sie daran interessiert sind, zu diesem Projekt beizutragen! Bevor Sie Ihren Beitrag einreichen, nehmen Sie bitte einen Moment Zeit und lesen Sie die folgenden Richtlinien durch:

Lesen Sie unsere beitragenden Richtlinien durch, um über unseren Einreichungsprozess, unsere Codierungsregeln und vieles mehr zu erfahren.

? Willst du helfen?

Möchten Sie einen Fehler melden, Code beisteuern oder die Dokumentation verbessern? Exzellent! Lesen Sie unsere Richtlinien für den Beitrag zu und sehen Sie sich dann eines unserer als HILFEL WUT oder guten ersten Ausgabe bezeichneten Probleme an.

? Verhaltenskodex

Helfen Sie uns, das Gesetz über das Recht offen und integrativ zu halten. Bitte lesen und folgen Sie unserem Verhaltenskodex.

Unterstützung und Organisation

Lizenz

Dieses Projekt ist gemäß den Bedingungen der MIT -Lizenz lizenziert.