diff --git a/README.md b/README.md index bdceaae..a91b106 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,32 @@ [![Build Status](https://drone.wtf-eg.de/api/badges/kompetenzinventar/ki-frontend/status.svg)](https://drone.wtf-eg.de/kompetenzinventar/ki-frontend) -Vue3 Projekt: +## Ü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 ```