Skip to content

Latest commit

 

History

History
55 lines (41 loc) · 2.99 KB

README.md

File metadata and controls

55 lines (41 loc) · 2.99 KB

KAG App

This repository does contain the app of a german school.

Dieses Repository beinhaltet die App des Konrad-Adenauer-Gymnasium Langenfelds. Der Code wird unter der GNU GPLv3 (siehe LICENSE Datei) bereitgestellt. Die App wurde von Schülern des K-A-Gs entwickelt und wird von diesen betreut. Pull Requests sind willkommen.

Typ Stable Develop/Master
Tests/Linter Tests Master Tests Develop
Deploy-Web deployWeb
Deploy-Stores deployStore

Die KAG App für iOS, Android, MacOS und Web. Geschrieben

API

Die API und deren Source Code ist nicht öffentlich. Die App ist mit der neusten Version der API kompatibel.

Starten

Um die App zu starten muss Flutter installiert sein. Dann mit flutter run starten.

Development

Bei der Entwicklung ist empfholen die Web Version lokal auszuführen. Wir halten uns grundsätzlich an die CONTRIBUTING.MD. Deswegen sollte diese vorher gelesen werden.

Alle Pull Requests sollten sich im Normalfall an den master richten

Forking

Gerne kann das Repository unter den Bedingungen der Lizenz geforked werden. Änderungen für den Eigengebrauch müssen vermutlich hauptsächlich in den API Dateien vorgenommen werden. Die Farben des Designes können in der main.dart angepasst werden.

Deploy

Alles was sich auf dem stable Branch befindet muss stabil sein. Der stable Branch wird bei einem Release automatisch für Android gebaut in den Playstore alpha Release deployed (dort sollten dann noch Changenotes hinzugefügt werden). IOS muss von einem MacOS Gerät aus über XCode gebaut und deployed werden. (Plan zum automatischen deployen ist Issue #88) Wie das geht steht hier Full Web und VPlan wird automatisch beim push auf stable deployed. Die App ist mit MacOS kompatibel, jedoch muss diese noch selber gebaut werden.

Aktuelle Version

Versionierung

Die aktuelle Versionierung stimmt mit dem VersionCode von Android bzw. der Buildnummer von IOS überein.
Die Version wird automatisch vom Buildscript bestimmt und stimmt mit der Anzahl der Releases überein.