diff --git a/README.md b/README.md index c1ad846..b9d7d86 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # GoHome -A repository to make a workhour report, which remids you of going home. Keep your Work Life balance \ No newline at end of file +A repository to make a workhour report, which remids you of going home. Keep your Work/Life Balance __<-- Do you see the Ironie?__ + + +# Repository Structure +coming soon + +# Versions +See more in the [versions.md](./docs/versions.md) +| Wich Version | When released | +| --- | --- | +| alpha | tbd | +| beta | tbd | +| 1.0 | tbd | +# Technologies +All the greate technologies used for this project +## Automated Builds & Tests +All builds and tests are done with [drone](https://www.drone.io/) +For the automated deployment I user [argocd](https://argoproj.github.io/cd/) + +## Database +For a database I use [mariadb](https://mariadb.org/) + +## Containers +As an container registry I use [VMWare Harbor](https://goharbor.io/) and [Docker Hub](https://hub.docker.com/) + +## Languages ++ GoLang --> for Backend ++ HTML --> Layouting ++ SASS --> Make it beautiful (well at least I try) ++ TypeScript --> Cause I have to + +## Frameworks ++ Ionic for front-end ++ Gin for back-end \ No newline at end of file diff --git a/docs/versions.md b/docs/versions.md new file mode 100644 index 0000000..47387a1 --- /dev/null +++ b/docs/versions.md @@ -0,0 +1,24 @@ +# Versions +| Version | Describtion | Release Date | +| --- | --- | --- | +| Alpha | Base functionallity | tbd | +| Beta | Bug fix & improvments from Alpha | tbd | +| 1.0 | First Version | tbd | +| 1.1 | Bug fix & improvments to Version 1.0 | tbd | + +# Features ✅ / ❌ +| ID | Version | Name | Description | Author | Requested by | Working | +| --- | --- | --- | --- | --- | --- | --- | +| 0 | alpha | Login Site | Working Login Site | Janic Voser | Janic Voser | ❌ | +| 1 | alpha | Add User | Add Site User | Janic Voser | Janic Voser | ❌ | +| 2 | tbd | Add Groups | Add Groups | Janic Voser | Janic Voser | ❌ | +| 3 | tbd | Organizations | Manage Organizations | Janic Voser | Janic Voser | ❌ | +| 4 | alpha | Starttime | Set beginning of work | Janic Voser | Janic Voser | ❌ | +| 5 | alpha | Endtime | Set end of work | Janic Voser | Janic Voser | ❌ | +| 6 | alpha | Pause | Substract Pausetime | Janic Voser | Janic Voser | ❌ | +| 7 | beta | Multi Pause | Substract multiple Pausetimes | Janic Voser | Janic Voser | ❌ | +| 8 | alpha | Expected work time | Time to work daily | Janic Voser | Janic Voser | ❌ | +| 9 | beta | Time Credit | Positiv & negativ Time credits | Janic Voser | Janic Voser | ❌ | +| 10 | tbd | Nice Graphs | Display nice Graphs of the work time | Janic Voser | Janic Voser | ❌ | +| 11 | beta | Backup | Backup Database & Assets | Janic Voser | Janic Voser | ❌ | +| 12 | beta | Profile Picture | Upload Profile Picture for Users | Janic Voser | Janic Voser | ❌ | \ No newline at end of file