diff --git a/docs/.vitepress/config.mts b/docs/.vitepress/config.mts index b33bd7934..9487f3f06 100644 --- a/docs/.vitepress/config.mts +++ b/docs/.vitepress/config.mts @@ -1,9 +1,9 @@ -import {defineConfig} from 'vitepress' +import {withMermaid} from "vitepress-plugin-mermaid" const PATH_TECHNIK = '/technik/'; // https://vitepress.dev/reference/site-config -export default defineConfig({ +export default withMermaid({ title: "Wahllokalsystem", description: "Datenerfassung am Wahltag", base: '/Wahllokalsystem/', @@ -22,12 +22,16 @@ export default defineConfig({ { text: 'Tools & Frameworks', link: `${PATH_TECHNIK}` }, { text: 'Getting Started', link: `${PATH_TECHNIK}get_started/` - } + }, + { text: 'Entwicklungsumgebung', link: `${PATH_TECHNIK}development/`} ] }, socialLinks: [ { icon: 'github', link: 'https://github.com/it-at-m/Wahllokalsystem/' } ] + }, + mermaidPlugin: { + class: "mermaid my-class", // set additional css classes for parent container } }) diff --git a/docs/src/technik/development/index.md b/docs/src/technik/development/index.md new file mode 100644 index 000000000..426499445 --- /dev/null +++ b/docs/src/technik/development/index.md @@ -0,0 +1,36 @@ +# Entwicklungsumgebung + +## Zusammenspiel IDE mit Docker + +```mermaid +flowchart LR + + subgraph Dev-PC + subgraph IDE + wlsService + end + + subgraph Docker + keycloak[Keycloak] + keycloakDB[db-postgres-keycloak] + keycloakInit[init-keycloak] + end + + wlsService ---|OAuth2| keycloak + + keycloak-->|persisting| keycloakDB + keycloakInit-->|setup of| keycloak + end +``` + +## Benutzer + +| Name | Passwort | Beschreibung | +| --- | --- | --- | +| keycloak_test | test | Ein Benutzer ohne weitere Rechte | +| wls_all | test | Ein Benutzer mit allen Rechten | + +## Beispiel-Requests + +Im Soap-UI-Projekt (`DockerTest-soapui-project`) und `docker.keycloak.http` sind Beispielrequests vorhanden. +Es kann für den jeweiligen Nutzer ein Token geholt werden. Außerdem ist die Anfrage an den UserInfo-Endpoint hinterlegt. \ No newline at end of file diff --git a/docs/src/technik/index.md b/docs/src/technik/index.md index 3321040c6..96f60de6f 100644 --- a/docs/src/technik/index.md +++ b/docs/src/technik/index.md @@ -10,6 +10,9 @@ Welche Tools und Framework haben wir zur Entwicklung verwendet. - Imageregistry - Zenhub - Projektmanagement +- Docker +- SoapUI + - Beispielrequests ## Frameworks