ki-frontend/README.md

98 lines
2.7 KiB
Markdown
Raw Normal View History

2021-09-19 12:55:33 +02:00
<!--
SPDX-FileCopyrightText: WTF Kooperative eG <https://wtf-eg.de/>
SPDX-License-Identifier: AGPL-3.0-or-later
-->
2021-05-31 16:14:28 +02:00
# ki-frontend
2021-07-26 21:07:57 +02:00
[![Build Status](https://drone.wtf-eg.de/api/badges/kompetenzinventar/ki-frontend/status.svg)](https://drone.wtf-eg.de/kompetenzinventar/ki-frontend)
2021-09-19 12:55:33 +02:00
[![REUSE status](https://api.reuse.software/badge/git.wtf-eg.de/kompetenzinventar/ki-frontend)](https://api.reuse.software/info/git.wtf-eg.de/kompetenzinventar/ki-frontend)
2021-06-07 17:41:25 +02:00
## Ü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).
2021-07-28 21:52:12 +02:00
2021-05-31 16:14:28 +02:00
## Project setup
```
2021-06-14 22:27:23 +02:00
npm ci
2021-05-31 16:14:28 +02:00
```
2024-02-11 15:09:35 +01:00
### 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
2021-07-28 21:52:12 +02:00
### Konfigurationsdatei anpassen
```
cp public/config.js.dev public/config.js
vi public/config.js
```
2021-05-31 16:14:28 +02:00
### Compiles and hot-reloads for development
```
2021-07-28 21:52:12 +02:00
npm run serve
2021-05-31 16:14:28 +02:00
```
### Compiles and minifies for production
```
2021-07-28 21:52:12 +02:00
npm run build
2021-05-31 16:14:28 +02:00
```
### Lints and fixes files
```
npm run lint
```
### Customize configuration
See [Configuration Reference](https://cli.vuejs.org/config/).
2021-06-07 17:41:25 +02:00
Vorraussetzung: Node & NPM
2021-06-14 22:27:23 +02:00
## Docker
### Image bauen
```
2021-07-26 21:01:45 +02:00
docker build --target ki-frontend --tag ki_frontend .
2021-06-14 22:27:23 +02:00
```
### Container starten
```
docker run \
--name=ki_frontend \
2021-07-28 21:52:12 +02:00
-v ${PWD}/public/config.js:/user/share/nginx/html/config.js \
2021-06-14 22:27:23 +02:00
-p 8000:80 \
ki_frontend
```