Dokumentation und issues für das Projekt Kompetenzinventar

Go to file

Lukas Grossberger a28bf9676d update instructions for build dependencies * typo in sphinx plantuml package name * make python and system dependencies explicit		2021-06-30 12:24:40 +02:00
doc	data model adapted to split between user and profile	2021-06-20 13:48:08 +02:00
.gitignore	initial README and docs taken over and adapted from membersteward-repo	2021-05-28 22:20:20 +02:00
Makefile	make builds now singlehtml and pdf version of document	2021-05-31 21:18:27 +02:00
README.md	update instructions for build dependencies	2021-06-30 12:24:40 +02:00

README.md

Kompetenzinventar

Dieses Repo enthält die Dokumentation des Projekts Kompentenzinventar - einer Webapplkation zur Erfassung von Userprofilen für die WTF eG.

In diesem Repo werden ausserdem die Issues des gesamten Kompentenzinventar-Projektes gesammelt.

Es existiert jweils ein Repo für den Frontend- und den Backend-Code:

Features

TBD

Features
Building
Contributing

Building

Building the ki-doku depends on the following Python packages:

sphinx
sphinxcontrib-plantuml

as well as the system dependency plantuml, which you can get e.g. with apt install plantuml

Building/using the ki-backend depends on python and flask, see the repo's environment specification for details.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

Fork the Project
Create your Feature Branch (git checkout -b feature/AmazingFeature)
Commit your Changes (git commit -m 'Add some AmazingFeature')
Push to the Branch (git push origin feature/AmazingFeature)
Open a Pull Request

License

Distributed under the ??? License. See LICENSE for more information.

Contact

Project Link: https://git.wtf-eg.de/kompetenzinventar