Compare commits

..

No commits in common. "master" and "master" have entirely different histories.

5 changed files with 68 additions and 147 deletions

View File

@ -1,37 +0,0 @@
---
name: "Bug"
about: "Fehler melden"
labels:
- bug
---
## Zusammenfassung
*hier kurze Beschreibung des Problems einfügen*
## Schritte zum Nachstellen des Problems
*hier Schritte so auffschreiben, dass der Fehler nachgestellt werden kann, z.B.*
- Ich öffne die URL X
- Ich gebe `blubb` in das Name Feld ein
- Ich klicke auf den bunten Knopf
**Erwartetes Verhalten**
*hier hinschreiben, was passieren sollte, z.B.*
Ein Einhorn reitet von links nach rechts über den Bildschirm
**Aktuelles Verhalten**
*hier hinschreiben, was im Moment passiert; ggf. mit Video oder Screenshot ergänzen*
Ein Troll läuft von rechts nach links über den Bildschirm
## Sonstiges
- Betriebssystem (inkl. Version): **z.B. Ubuntu 20.04.3 LTS**
- Browser (inkl. Version): **z.B. Firefox 95.0.1 (64-bit)**

View File

@ -1,24 +0,0 @@
---
name: "Feature"
about: "Ein neues Feature bestellen"
labels:
- enhancement
---
## Zusammenfassung
*hier kurze Beschreibung des gewünschten Features einfügen*
## Anwendungsfall
*hier den Anwendungsfall beschreiben*
*Warum möchte ich das haben?*
*Wie soll das neue Feature funktionieren?*
## Anhänge
*gerne Skizzen einfügen*

View File

@ -1,8 +0,0 @@
FROM sphinxdoc/sphinx-latexpdf
RUN pip3 install sphinxcontrib-plantuml
RUN apt-get update && apt-get install plantuml locales-all -y
ENV LC_ALL="de_DE.UTF8"
WORKDIR /doc
CMD ["make", "latexpdf", "singlehtml"]

View File

@ -13,31 +13,28 @@ Es existiert jweils ein Repo für den Frontend- und den Backend-Code:
- https://git.wtf-eg.de/kompetenzinventar/ki-frontend.git
- https://git.wtf-eg.de/kompetenzinventar/ki-backend.git
## Features ##
TBD
## Contents
- [Features](#features)
- [Building](#building)
- [Contributing](#contributing)
## Building
Building the ki-doku depends on the following Python packages:
* `sphinx`
* `sphinxcontrib-plantuml`
building the ki-doku depends on python, sphinx,
sphinx-contrib-plantuml und plantuml.
as well as the system dependency `plantuml`, which you can get e.g. with `apt install plantuml`
### Building with Docker
You can also build the docs using docker:
docker build -t ki-doku-builder .
docker run -v $(pwd)/doc:/doc ki-doku-builder
# results:
# ./doc/build/latex/kompetenzinventar.pdf
# ./doc/build/singlehtml/
Warning: the builder uses the `sphinx-latexpdf` base image, which contains an entire texlive environment, making it very large (~2.9G).
building/ using the ki-backend depends on python and flask.
<!-- ROADMAP -->
## Roadmap
See the [open issues](https://github.com/github_username/repo_name/issues) for a list of proposed features (and known issues).
<!-- CONTRIBUTING -->
## 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**.
@ -48,14 +45,23 @@ Contributions are what make the open source community such an amazing place to b
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
(Pull requests currently require an account on our private gitea, but we faithfully await deliverance from our federated [lord and saviour](forgefed.org).)
<!-- LICENSE -->
## License
Distributed under the ??? License. See `LICENSE` for more information.
<!-- CONTACT -->
## Contact
<!--
Your Name - [@twitter_handle](https://twitter.com/twitter_handle) - email
-->
Project Link: [https://git.wtf-eg.de/kompetenzinventar](https://git.wtf-eg.de/kompetenzinventar)
<!-- ACKNOWLEDGEMENTS -->
## Acknowledgements
* []()
* []()
* []()

View File

@ -9,52 +9,18 @@ skinparam linetype ortho
entity "user" as user {
*id : number <<generated>>
--
*auth_id : text(50)
' *created: datetime
' *updated: datetime
}
entity tag {
*id : number <<generated>>
*tag_type_id
--
*name: text
}
entity tag_type {
*id : number <<generated>>
--
*name: text
}
tag_type ||--o{ tag
entity profile {
*id : number <<generated>>
*user_id
--
*nick_name : text(25)
*nickname : text(25)
pronouns : text(25)
fullname: text(100)
volunteerwork: text(4000)
freetext: text(4000)
visible: bool
*created: datetime
*updated: datetime
}
user ||-o{ profile : user_has_profile
entity token {
entity user_address {
*id : number <<generated>>
*user_id
--
*token : text(36)
}
user ||-o{ token : user_has_token
entity profile_address {
*id : number <<generated>>
*profile_id
*userid
--
street: text(25)
house_number: text(10)
@ -63,40 +29,52 @@ entity profile_address {
city: text(25)
country: text(25)
}
profile ||-o{ profile_address : profile_has_address
user ||-o{ user_address : user_has_address
entity profile_skill {
*profile_id: id
entity user_skill {
*user_id: id
*skill_id: id
--
*level: number
level: number
}
entity profile_language {
*profile_id: id
entity user_language {
*user_id: id
*language_id: id
--
level: number
}
entity profile_experience {
entity skill {
*id : number <<generated>>
*profile_id
--
*name: text(25)
}
entity user_experience {
*id : number <<generated>>
*user_id
--
description
start: date
end: date
}
entity profile_experience_experience {
*profile_experience_id
entity user_experience_experience {
*user_experience_id
*experience_id
}
profile ||--o{ profile_experience : user_has_experience
profile_experience ||--o{ profile_experience_experience : user_experience_is_tagged_with
user ||--o{ user_experience : user_has_experience
user_experience ||--o{ user_experience_experience : user_experience_is_tagged_with
entity experience {
*id : number <<generated>>
--
*name: text(25)
}
user_experience_experience }o--|| experience
profile_experience_experience }o--|| tag
entity user_search_topic {
*user_id
@ -104,14 +82,20 @@ entity user_search_topic {
--
}
entity profile_contact {
entity user_contact {
*id : number <<generated>>
*profile_id
*user_id
*contact_type_id
--
*content: text(200)
}
entity topic {
*id : number <<generated>>
--
*name: text
}
entity language {
*id : number <<generated>>
--
@ -124,16 +108,16 @@ entity contact_type {
*name: text(25)
}
profile ||--o{ profile_skill : user_has_skills
profile_skill ||--o{ tag
user ||--o{ user_skill : user_has_skills
user_skill ||--o{ skill
profile ||--o{ profile_language : user_speaks_language
profile_language||--{ language
user ||--o{ user_language : user_speaks_language
user_language||--{ language
user ||--o{ user_search_topic
user_search_topic ||--o{ tag
user_search_topic ||--o{ topic
profile ||-o{ profile_contact
profile_contact ||-o{ contact_type
user ||-o{ user_contact
user_contact ||-o{ contact_type
@enduml