Frontend

LICENSE

@@ -58,7 +58,7 @@ APPENDIX: How to apply the Apache License to your work.
 
 To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives.
 
-Copyright [yyyy] [name of copyright owner]
+Copyright 2022 Janic Voser
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

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
+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

backend/BACKEND.md

@@ -0,0 +1,2 @@
+# Backend
+The backend is the API which serves every content under the web root /api

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 | ❌ |

frontend/FRONTEND.md

@@ -0,0 +1,2 @@
+# Frontend
+The Frontend is the visual part of this project