forked from kompetenzinventar/ki-frontend
98 lines
2.7 KiB
Markdown
98 lines
2.7 KiB
Markdown
<!--
|
|
SPDX-FileCopyrightText: WTF Kooperative eG <https://wtf-eg.de/>
|
|
|
|
SPDX-License-Identifier: AGPL-3.0-or-later
|
|
-->
|
|
|
|
# ki-frontend
|
|
|
|
[](https://drone.wtf-eg.de/kompetenzinventar/ki-frontend)
|
|
[](https://api.reuse.software/info/git.wtf-eg.de/kompetenzinventar/ki-frontend)
|
|
|
|
## Über
|
|
|
|
Dieses Repo enthält das Frontend des Projekts Kompentenzinventar - einer Webapplikation zur Erfassung von Userprofilen für die WTF eG.
|
|
|
|
Implementiert ist das Frontend mit Vue3.
|
|
|
|
### Mitmachen
|
|
|
|
Du kannst gerne bei der Entwicklung des Kompetenzinventars mitmachen.
|
|
|
|
- Fehler oder fehlende Funktionen erfassen. Bitte direkt über die [Issues](https://git.wtf-eg.de/kompetenzinventar/ki-frontend/issues) in Gitea.
|
|
- Dokumentation oder Implementierung verbessern. Bitte forke hierzu das Projekt, branche von `main` ab und erstelle dann einen [Pull Request](https://git.wtf-eg.de/kompetenzinventar/ki-frontend/pulls).
|
|
|
|
### Kommunikation
|
|
|
|
Folgende Kanäle gibt es für die Kommunikation über das Kompetenzinventar:
|
|
|
|
- Die [Issues](https://git.wtf-eg.de/kompetenzinventar/ki-frontend/issues) im WTF Gitea.
|
|
- Den Bereich [AG Entwicklung](https://forum.wtf-eg.de/c/interna/ag-entwicklung/21) im WTF Forum.
|
|
- Einen Raum in Matrix. Zutritt per Einladung, frlan lädt ein, eine einfache PN im Forum reicht.
|
|
|
|
### Repos
|
|
|
|
* [ki-backend](https://git.wtf-eg.de/kompetenzinventar/ki-backend) enthält das Backend
|
|
* **[ki-frontend](https://git.wtf-eg.de/kompetenzinventar/ki-frontend)** (dieses Repo) enthält das Frontend
|
|
* Weitere Repositories befinden sich in der Gitea Organisation [Kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar).
|
|
|
|
## Project setup
|
|
```
|
|
npm ci
|
|
```
|
|
|
|
### Pre requirements
|
|
|
|
* Node 20
|
|
* Wenn du eine andere node version installiert hast, kannst du [nvm](https://github.com/nvm-sh/nvm) benutzen um schnell zwischen node version zu wechseln
|
|
* NPM
|
|
* (KI-backend)[https://git.wtf-eg.de/kompetenzinventar/ki-backend] muss lokal laufen
|
|
|
|
|
|
### Konfigurationsdatei anpassen
|
|
|
|
```
|
|
cp public/config.js.dev public/config.js
|
|
vi public/config.js
|
|
```
|
|
|
|
### Compiles and hot-reloads for development
|
|
```
|
|
npm run serve
|
|
```
|
|
|
|
### Compiles and minifies for production
|
|
```
|
|
npm run build
|
|
```
|
|
|
|
### Lints and fixes files
|
|
```
|
|
npm run lint
|
|
```
|
|
|
|
### Customize configuration
|
|
See [Configuration Reference](https://cli.vuejs.org/config/).
|
|
|
|
Vorraussetzung: Node & NPM
|
|
|
|
|
|
## Docker
|
|
|
|
### Image bauen
|
|
|
|
```
|
|
docker build --target ki-frontend --tag ki_frontend .
|
|
```
|
|
|
|
|
|
### Container starten
|
|
|
|
```
|
|
docker run \
|
|
--name=ki_frontend \
|
|
-v ${PWD}/public/config.js:/user/share/nginx/html/config.js \
|
|
-p 8000:80 \
|
|
ki_frontend
|
|
```
|