polytalon / climbing-gym-app

App designed for climbing gyms and climbers alike.

GripGuide

An idea by Polytalon, designed and built by students of the HTWG Konstanz.

GripGuide is an app designed for climbing gyms and climbers alike. It provides gyms with the opportunity to publish routes and news, while climbers can track their progress and give feedback to the gym.

Feature overview

Generally, the app allows registering as a user and choosing your current gym. After registering, users can use the gym's routes to track their progress and get an overview of their current performance.

Gym owners and route setters can add, remove and edit routes. Additionally, gym owners can publish news, to be displayed for every gym-user of their gym.

All of these features, including editing routes and gyms, can be used from withing the app and without manually editing the configuration in the backend. Gyms, their owner and global news can only be added by an operator, while a gym owner can add route setters and local news to their gym.

Technology

To build the user-interface, we use Flutter, which compiles down to native iOS and Android apps. The backend is build using Firebase, as it provides an easy Flutter integration.

We test and deploy our code using automated GitHub Actions that ran on different points during the development process. Our GitHub Actions include automatic testing of builds for iOS and Android.

The project can also be compiled as a Web-App, but is currently not actively maintained, as it isn't part of our current scope.

Development Team

• Andreas Ly
• Bernhard Gundel
• Julian Sabo
• Nail Özmen
• Sascha Villing
• Sebastian Voigt
• Timmy Pfau

climbing-gym-app's Issues

Security Rules: Firestore Gyms und News

• check for Roles
• check Field Types

Design: We might need a back button at the top of the login screen on nativ iOS.

Google Login

The user should be able to login via his/her Google Account.

Assign permissions

depends on #57

• Operator can authorise other operators.
  If a operator, give a User the Role operator, must be follwing created:
  A subcollection below the "/Users//" collection named "private/operator/" with the field "operator: true"

• Gymuser can authorise builder:
  If a gymuser, give a User the role builder, must be following created in the db if it does not already exist:
  The Collection "/Privileges//" with the field "normaluser: true" and below it the subcollection "private/roles/" with the field "gymuser: true".

• Also revoke the permission must be implemented

API Key Secure behandlung in Flutter

Database schema

We need to plan a valid database schema that allows for users, climbing gyms and their relationship.

• user table
  • name
  • optional location?
  • optional age?
  • etc.
• climbing gym table
  • location
  • name
  • etc.
• A way to match the permissions of a user to a climbing gym

Generally all of the data above is a must, additional information should be easy to add if necessary.
Therefore we should start planing and actually implementing the scheme soon.

Deployed Web App - Logout & Google Login fails

Steps how to reproduce:

• deploy build/web folder with firebase
• open web app
• click "sign in with google"

Implement 'hasRole'-Function in Firestore Rules

A hasRole-function should be implemented in the Firestore rules to check the user roles in the client.

Implement Logout functionality

The user should be able to log out of the app - once logged in.

Send e-mail verifications after register

Presentation

About the presentation for next week and the general presentation of the project (readme/documentation).

ACL (User Roles) creation Firebase for User, Gyms and Provider

See this:
https://firebase.google.com/docs/firestore/solutions/role-based-access
For Example: Gyms may only delete their own created content etc.
https://firebase.google.com/docs/auth/admin/custom-claims#node.js

Choose your gym logic create privileges in DB

• If select a gym as a logged-in user, the privilges must be stored in the DB at Users:
• below "users//" must be created a subcollection if not exists "ptivileges//" with the field "normaluser: true"
• also the unchoose must be implemented

Automatic Deployment for Web crashes

The automatic deployment of the web version crashes, because there is no public-Folder.
Instead, the web version should be deployed from "/build/web/".

[Web] Accessing Firebase Storage (images) causes CORS Problem

only in Web, when trying to load gym image e.g.

Firestore SecRules: implement email_verified if the verifications are implemented

This issue depends on #37

Deployment job is failing

/usr/local/bin/npx firebase-tools deploy --only hosting --project flutter-test-31e18 --json
***
"status": "error",
"error": "Specified public directory 'build/web' does not exist, can't deploy hosting to site flutter-test-31e18"

Copied from a failed deployment run.

Screen: About Page

Back Button : Login Screen

Deployment for Testing

Disable landscape mode

just disable it 💯

Login: Show password in cleartext button

• https://stackoverflow.com/questions/49125064/how-to-show-hide-password-in-textformfield

Changing minimal iOS deployment Target

• Change of the minimum iOS deployment target to the one discussed on 12.05

Persistent Web Auth

We want the user to be loggedin after closing and reopening the browser :)

Design - Filterfunktion überarbeiten und Übersicht der ausgewählten Filter einfügen

Implement "Forgot Password?"

Style guideline

General

• Why is this an issue? Because I want feedback and everybody can easily tell my why this guide is wrong and everything should be done differently
• Shouldn't we fork the project an work on this fork? Probably yes, but we are all somehow lazy, aren't we?

Branches

A personal branch should always start with you username. Every branch that does not have a leading username is a special branch that is used to synchronize work (main, development and feature-branches). Where main is the branch tracking the current release and development is used to collect features for release.

If you are working on a feature or fix a bug that is part of an issue, you create a branch that follows the form of username/issue/issue-id. This way it is clear that you are working on a specific issue.
If you work on something that is not part of an issue (shame on you), the naming-scheme should be username/information-about-branch. The information-about-branch should describe the work you are doing correctly and clearly.

If multiple people work on a single issue, a special branch is created that has the form issue/issue-id. This branch is used for synchronization and then merged into development.

Pull-Requests

You shall not merge into main, development or a feature-branch without a pr!
It is annoying to have new commits without information about what they do, do a pull-request and assign the correct people to it.

If you are working on an issue, reference the issue in the pull-request. Have look at the official documentation about how to do this..

Clean up after a successful merge. GitHub makes it easy to remove merged feature branches, if they are not used anymore, delete them.

Commits

If you want information about commit messages.

Google Login native iOS

CI Testing

There should be some kind of CI and build automation in place.
I would propose a simple build process that gets executed on every pull-request and builds the web, android and iOS version of the app.

If we start writing tests at some point this can be extended to automatically run all tests.

Cloud Firestore create and connect to the App

Native iOS: The Noch Icons on the light mode from iOS are still black, therefore not visible

Design - Filterfunktion und Routenansicht

Design - neue News anlegen

Design - Kletterhallen und Routen erstellen

Image compression before uploading

Add timeout to GitHub Actions

Add App Icon for native Apps

Firestore Security Rules: Routen

Screen: News ( + Add News as Provider)

Firebase mit Polytalon Account

Add Gyms as Provider

The provider needs to add gyms to the database with a photo or an image.

Create Mock Data (Gyms, Routes, etc.)

Design: Assign permissions (gymuser and Operator)

• Operator can authorise gymuser and other operators.
• Gymuser can authorise builder.

Add News and Add Gym Screen visibility for operator only

(Add Gyms/News/Routes) Imagepicker: Show picked image

Screens: Add Gym / Add News / Add Routes /....

currently it is not visible if a image is picked
Lets change that 💯

Create DatabaseService

Flutter Dummy App

Save 'displayname' when registering user

User Register create Data Set in DB

Screen: Gyms