Update root and script readmes

readme.md

@@ -2,12 +2,15 @@
 
 # IT1901 Prosjekt - Script
 
-_Script lar deg organisere notater og påminnelser for å hjelpe deg med ulike aktiviteter_
+_Script lar deg organisere notater og sjekklister for å hjelpe deg med ulike aktiviteter_
 
 Alt av dokumentasjon ligger under [docs](/docs) og er sortert etter utgivelser av prosjektet.
 
 ## Struktur
-Mappen `script` utgjør kodingsprosjektet. Prosjektet er bygd med maven og består av tre delmoduler: `core`, `data` og `ui`. Core-modulen inneholder hovedklassene og data-modulen inneholder både data og klasser for filbehandling. Ui-modulen inneholder kontroller samt fxml-filer og alt annet av ressurser som trengs til brukergrensesnittet.
+Mappen `script` utgjør kodingsprosjektet. Prosjektet er bygd med maven og består av fire delmoduler: `core`, `data`, `ui` og `springboot`. Core-modulen inneholder hovedklassene og data-modulen inneholder klassen DataHandler for filbehandling. Ui-modulen inneholder kontroller samt fxml-filer og alt annet av ressurser som trengs til brukergrensesnittet. Springboot-modulen inneholder alt som brukes til å lage api-et.
+
+## Script-applikasjonen
+Java-applikasjonen vår lar brukere opprette ulike brett hvor de kan lagre notater og sjekklister. Alt lagres automatisk, noe som leder til en god brukeropplevelse. 
 
 ## Roadmap
 - [x] Modular structure
@@ -16,13 +19,5 @@ Mappen `script` utgjør kodingsprosjektet. Prosjektet er bygd med maven og best
     - [x] Controller
 - [x] Unit tests and CD/CI pipeline
 - [ ] Search functionality
-- [ ] List functionality with checkboxes in notes
-- [x] Custom JSON serializer
-
-## Kjøring av FXUI-klienten
-
-Den lokale javafx-klienten er bare konfigurert til å starte opp med maven fra mappen `script/ui`, så for å kjøre FXUI, kjør
-
-```sh
-cd script && mvn clean install && cd ui && mvn javafx:run
-```
+- [x] List functionality with checkboxes in notes
+- [x] Custom JSON serializer

script/README.md

@@ -1,30 +1,37 @@
 # Script
 
-Script er en enkel app som lar en bruker opprette, redigere, sortere og slette notater. Videre dokumentasjon til de forskjellige utgivelsene finnes i [/docs](/docs).
+Script er en enkel app som lar en bruker opprette, redigere, sortere og slette notater og sjekklister. Videre dokumentasjon til de forskjellige utgivelsene finnes i [/docs](/docs).
 
 Under er det et skjermbilde av appen som er befolket med noen enkle notater. 
 
 ![](/docs/release1/img/JavaFXinterface.png)
 
 ## Struktur
 
-[core](/script/core/) inneholder kjernelogikken som handler om oppslagsbretten, notatene og deres innhold.
-[ui](/script/ui/) inneholder controllere og FXML filene som kjører brukergrensesnittet
-[data](/script/data/) lagrer og henter frem data
-
-[report](/script/report/) brukes kun til JaCoCo-rapporter
+- [core](/script/core/) inneholder kjernelogikken som handler om oppslagsbrettene, notatene og deres innhold.
+- [ui](/script/ui/) inneholder kontrollere og FXML filene som kjører brukergrensesnittet.
+- [data](/script/data/) lagrer og henter frem data.
+- [springboot](/script/springboot/) brukes til å lage api-et.
+- [report](/script/report/) brukes kun til JaCoCo-rapporter.
 
 
 ## Brukerhistorier
 Vi har laget noen brukerhistorier som skal hjelpe oss med å kartlegge bruksområdene til appen, og gi oss en bedre idé om hvilke funksjonaliteter appen skal ha.
-Brukerhistorie #1 til release 1 ligger [her](/docs/release1/userStories.md). Brukerhistorie #2 og #3 til release 2 ligger [her](/docs/release2/userStories.md).
-
-
-## Kjøre JavaFX-brukergrensesnittet
-- Gå inn i `script` mappen.
-- Kjør `mvn clean install`
-- Gå inn i `ui`
-- Kjør `mvn javafx:run`
+Brukerhistorie #1 til release 1 ligger [her](/docs/release1/userStories.md). Brukerhistorie #2 og #3 til release 2 ligger [her](/docs/release2/userStories.md). Brukerhistorie #4 og #5 til release 3 ligger [her](/docs/release%203/userStories3.md).
 
 
+## Kjøre springboot
+1. Gå inn i `script`-mappen. ([script](/script/))
+2. Kjør `mvn clean install -DskipUiTests -DskipTests`
+3. Bytt mappe til `springboot/server`. ([springboot/server](/script/springboot/server))
+4. Kjør `mvn spring-boot:run`
 
+## Kjøre JavaFX-brukergrensesnittet
+1. Pass på at du har startet springboot
+2. Gå inn i `script`-mappen. ([script](/script/))
+3. Kjør `mvn clean install`
+4. Bytt mappe til `ui`. ([ui](/script/ui/))
+5. Kjør `mvn javafx:run`
+
+## Bygge java-klient
+For å bygge en portabel versjon av applikasjonen, følg instruksjonene i [ui](/script/ui/) sin readme.