Spohn App - for people associated with the Spohngymnasium in Ravensburg, Germany

Related tags

App spohn-app
Overview

Spohn App

This is the application for people associated with the Spohngymnasium in Ravensburg, Germany.

It aims to provide easy access to relevant information regarding the students and teachers lives at school, for example a list of current substitutions or news.

Features

  • Substitutions (planned)
    • Filterable by class (planned)
  • News feed (planned)
  • Current cantine menu (planned)
  • Integration with the students timetable (planned)

Contributing

Contributions to this repository are always welcome.
However, please conform to the following guidelines to keep this project clean:

Development environment

This is a KotlinMultiplatformMobile (KMM) project.
Therefore, we are using AndroidStudio and Xcode, as well as the AndroidStudio plugin for KMM. Please refer to the setup manual for KMM to setup your IDE.

Repository layout

We use the following system for branching:

Branch Usage
develop This is the default branch. Developing of new features happens here.
feature/ These are custom branches created for each feature. They are forked off the protected develop-Branch and are merged back into develop after the feature is done.
testing After the changes in develop are ready for a new release, they are merged into this branch.
Here, the complete App is to be tested with unit tests and also manually, before deploying it to production!
If any bugs are found during testing or in production, they are fixed in this branch.
If a feature turns out to be incomplete, it returns to its own feature/-Branch.
production When testing is done, testing is merged here and a new version is released. No developing whatsoever is done on this branch!
Each release that is rolled out should also be tagged with the version number. One can also make use of GitHub releases to ship signed app bundles.
documentation This branch is not for any form of coding, but only for updates to documentation (like this README)

The main branches develop and production are protected, which means, one can't directly push code to them. They have to be adressed using pull requests.

Coding Guidelines and Documentation

Feature planning

Before you begin developing a feature, you need to plan its structure with UML.
This helps you and others understand, what your code is supposed to be doing and provides a structure for you during development of said feature.
You could, for example, use Visual Paradigm or any other UML or flowchart program.

Put the completed flowchart in docs/classCharts.

File length

Source code file should not be longer than 200 lines in total. If a file becomes longer than this limit, split it up into multiple files according to their functionality.
This keeps the code within a file comprehensible.

Documentation

Every function, no matter how trivial, is to be documented!
Each function of the code must be understood by simply looking at it to grasp the concepts of a feature.
Also, every function has to be understood by looking at the pop-up documentation inside code-completion to be able to code more efficently without looking up the source of every function one wants to use.

Ownership declaration

At the beginning of each file has to be a declaration of code ownership (i.e. who wrote this code**.
With this ownership information, future developers seeking to understand or modify the code know whom to ask questions regarding the code.
If code is amended by someone, said person should also add their name to the header.

Commits

Every commit is required to have a meaningful commit message, outlining the changes in detail!
DO NOT write something like bug fix as only text into the message, but rather explain which bug was fixed.

You might also like...
Food Recipe App is an app for collecting most of food recipe in one app

Food Recipe App is an app for collecting most of food recipe in one app

Library to change Android launcher App Icon and App Name programmatically !

AppIconNameChanger Change Android App launcher Icon and App Name programmatically ! Download Demo APK from HERE Kindly use the following links to use

The app has got fullscreen Turkey map via Huawei Map. App selects random province and shows it borders on the map than user will try to guess the provinces name.
The app has got fullscreen Turkey map via Huawei Map. App selects random province and shows it borders on the map than user will try to guess the provinces name.

Il Bil App Introduction I will introduce you to how to implement Account Kit, Map Kit, Game Service. About the game: The app has got fullscreen Turkey

HideDroid is an Android app that allows the per-app anonymization of collected personal data according to a privacy level chosen by the user.
HideDroid is an Android app that allows the per-app anonymization of collected personal data according to a privacy level chosen by the user.

HideDroid An Android App for preserving user privacy HideDroid is an Android app that allows the per-app anonymization of collected personal data acco

Book Parking is a demo application based on MVVM architecture. The app allows users to booking parking slots, the app uses firebase for the backend.
Book Parking is a demo application based on MVVM architecture. The app allows users to booking parking slots, the app uses firebase for the backend.

Book Parking is a demo application based on MVVM architecture. The app allows users to booking parking slots, the app uses firebase for the backend.

Ride-Sharing Uber Lyft Android App - Learn to build a ride-sharing Android Taxi Clone App like Uber, Lyft - Open-Source Project By MindOrks
Ride-Sharing Uber Lyft Android App - Learn to build a ride-sharing Android Taxi Clone App like Uber, Lyft - Open-Source Project By MindOrks

Ride-Sharing Uber Lyft Android App - Learn to build a ride-sharing Android Taxi Clone App like Uber, Lyft - Open-Source Project By MindOrks

Water tracker app helps you with daily reminder to drink water. This app is just a trial to test and improve my android development skills.
Water tracker app helps you with daily reminder to drink water. This app is just a trial to test and improve my android development skills.

🚀 About Me I am a self-thaught developer learning web and android development. This app is just a trial to test and improve my android development sk

Visual Studio App Center Sample App for Android

Visual Studio App Center Sample App for Android The Android application in this repository and its corresponding tutorials will help you quickly and e

Comments
  • VPLAN - UI: Add a Form of Enlargening

    VPLAN - UI: Add a Form of Enlargening

    Add some possibility to make the displayed text larger than in the default table. Some ideas:

    • Zooming the table
    • Detail view for each substitution / class
    enhancement 
    opened by JonFStr 0
  • About-Page: Add to app

    About-Page: Add to app

    Add an about-view into the app displaying:

    • Current app version
    • Link to homepage
    • Imprint
    • Privacy Policy
    • Mail-Address
    • Possibly licenses of used libraries
    enhancement 
    opened by JonFStr 0
Owner
Spohngymnasium Ravensburg
Spohngymnasium Ravensburg
Kalam is an app that gives people a chance to write their stories on the app.

Kalam is an app that gives people a chance to write their stories on the app. This app gives a good story for the story readers and gives good story writers a chance to write their own story

Uday Chugh 0 Apr 26, 2022
This app reminds people to take medicine according to their respective schedule.

Medicine Reminder App Reminds people for medicine. Objective In this busy and competitive world, it is very difficult for a person to remember each an

Naman Agarwal 4 Jun 3, 2021
An android mobile app for connecting volunteers with people in need.

NeighborGood An android mobile app for connecting volunteers with people in need. Using a single app create profiles for both "helpers" and "helpees"

null 0 Nov 2, 2021
Haven is an app to help people in need find resources.

Haven Haven is an app to help people in need find resources. Haven connects people to resources such as food pantries, homeless shelters, healthcare,

Dev Patel 2 Sep 25, 2022
This app aims at helping people keep track of their job applications, and remind them regularly about the same.

Applications Tracker Lately I have been applying for many roles, and it has become a hard task to keep track of all the applications. Spreadsheets are

Kartik Pant 4 Feb 20, 2022
This is an android app using which users can chat to people nearby them with help of Bluetooth.

This is an android app using which users can chat to people nearby them with help of Bluetooth. This app is developed in Kotlin programming language. It is still in its early stages of development and currently let user to one-person-one-time chat at a time. It is under heavy development ????

Shalu Ambasta 4 Sep 28, 2022
Connect is an Android Application to connect people for a project and can then work on the application to efficiently complete the project

Connect is an Android Application to connect people for a project and can then work on the application to efficiently complete the project

Shubhaprasad Padhy 1 Jan 9, 2022
Groceries Store is a project to help people order grocery online

?? Groceries Store Download on Google Play Store About Groceries Store is a project to help people order grocery online. The main purpose of this proj

Hieu Vu 128 Jan 1, 2023
This is a food donation android application designed to reduce food wastage by donating excess food to poor or needy people. Based on Kotlin and currently under development

FOODONOR This is a food donation android application designed to reduce food wastage by donating excess food to poor or needy people. Based on Kotlin

Robert Muriithi 8 Oct 12, 2022
An easy, cross-platform method of keeping track of other people's timezones

TimezoneDB TimezoneDB is an easy, cross-platform method of keeping track of others' timezones. This project is inspired by PronounDB, and we'd like to

Synapse Technologies, LLC 13 Nov 16, 2022