From b8cd4c7cfa76f4a783644725a5c7b28697b824c0 Mon Sep 17 00:00:00 2001 From: gusjak251 Date: Tue, 19 Dec 2023 21:50:47 +0100 Subject: [PATCH 1/2] Add more details to README.md --- README.md | 47 ++++++++++++++++++++++++++++++----------------- 1 file changed, 30 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index 5951f78..43a5a76 100644 --- a/README.md +++ b/README.md @@ -3,22 +3,6 @@ ## Projektbeskrivning Utveckla en MVP för en informationshanteringsapplikation avsedd för svenska myndigheter, med syftet att nyttja kraften hos språkmodeller för hantering av ostrukturerad data. Applikationen är intuitivt konstruerad för enkel uppladdning och hämtning av sådan data, och är skräddarsydd för en bred implementering över diverse organisatoriska miljöer. -## Snabbstart - -Starta alla moduler - -```bash -./start_everything.bash --watcher --mail --model -``` - -Starta moduler separat - -```bash -./start_everything.bash --watcher -./start_everything.bash --model -./start_everything.bash --mail -``` - ## Innehållsförteckning - [Kravspecifikation](#kravspecifikation) - [Installation](#install_and_run) @@ -59,17 +43,46 @@ Beskrivning: Med tanke på målgruppen (myndigheter) är hög säkerhet och syst ## Installation av projektet +Denna installationsguide är anpassad för Ubuntu 22.04 + ### Installera moduler + +1.Klona projektet från github +2.Öppna sökvägen i terminalen +```bash +cd Effektiv-Administration +``` +3.Installera de moduler som krävs för att köra projektet ```bash -pip install -r requirements.txt +pip install -r requirements.txt ``` +[Dokumentation för ChromaDB](https://docs.trychroma.com/) + ## Användande +### Snabbstart + +Starta alla moduler + +```bash +./start_everything.bash --watcher --mail --model +``` + +Starta moduler separat + +```bash +./start_everything.bash --watcher +./start_everything.bash --model +./start_everything.bash --mail +``` + ### API Starta API:et +Detta kommando körs från root-mappen + ```bash python3 src/server_model.py ``` From da8662679df296427c35c26c5d574de8f9b54c71 Mon Sep 17 00:00:00 2001 From: gusjak251 Date: Tue, 19 Dec 2023 21:53:09 +0100 Subject: [PATCH 2/2] Add clarifications to README.md --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 43a5a76..855f4c9 100644 --- a/README.md +++ b/README.md @@ -122,6 +122,8 @@ Exempel på svar då korrekt formaterad prompt har skickats med Starta funktionsbrevlådan +Detta kommando körs från root-mappen + ```bash python3 src/server_mail.py ```