The goal of fingerfunke was to create an App to better connect the deaf-language community in Germany. To achieve this we developed a platform to create events and form groups. Our main focus point was to prioritize the needs of deaf people. This for example meant to focus on video as the primary means of communicating, instead of text.
Unfortunately, as of September 2023, the project is paused and no further work will be completed for the foreseeable future. Of course, if someone wants to take over this project, please feel free to contact Tim at tim.lindenau@outlook.de
This repository is only a mirror of the original one. The original code including all supporting repositories can be found in our GitLab.
A glimpse into the main feed, showcasing the latest events and updates. |
Detailed view of event information, including time, location, and attendees. |
Interface for creating and editing event details. |
A chat feature for real-time communication among users. |
Notification system to keep users informed about important updates. |
If you build the App, please make sure you are using the following build environment
- Flutter 3.10.1
- Dart 3.0.1
- CocoaPods 1.10.1 (low version has to do with CI/CD pipeline)
The old way of downloading config files from google is deprecated. The new way is to use the firebase CLI as outlined here. This has the advantage that you no longer have to deal with configuration files manually.
The steps for using the firebase CLIare
- If you do not already have the
firebase CLIinstall it vianpm install -g firebase-toolsand login - Also install the
FlutterFireCLIby runningdart pub global activate flutterfire_cli - Once installed go to the root of this project, run
flutterfire configureand follow the following steps
- Select a firebase project -> select fingerfunke
- Which platform should your configuration support -> select android and ios
- In the next step the android app should be found automatically leading to the output
Firebase android app app.fingerfunke.fingerfunke registered. - We are using a different name for the ios app, thus it is not found automatically. Thus, when prompted for
Which ios bundle id do you want to use for this configuration, e.g. 'com.example.app'?enter the nameapp.fingerfunke.fingerfunke-mobile-app - Finally select
yesto continue
After following these steps you must also make sure that you are using the right configuration. For more information on this please refer to the Configuration Setup section
to enable l10n a code generator must be executed. It can be started in one of two ways:
- starting the app (while ignoring build errors) starts the generator automatically
- running the generator manually:
- navigate to the
/lib/l10n/directory - in VS-Code right click on
app_en.arband selectGenerate Localizations
- navigate to the
Generally the recommended way in dart to provide environment variables is via dart-define. Using this approach allows environment variables to be easily accessed both in dart code and in native code. A good tutorial for how to use dart-define is this one.
The old process of copying .env files is obsolete. Instead you must make sure the the private fingerfunke configuration repo is cloned next to this repo. If this is the case, you can simply build the App for different environments using the provided run scripts in visual studio code (see launch.json).
If you want to run manually this is also possible, however, you must then provide the flag flutter run --dart-define-from-file <path to the config.json>. It is also possible to setup automatic build scripts like in vscode for android studio. For more information please refer to this tutorial.
Dart Code
To define a new environment variable, just add it to the proper config.json file in the private fingerfunke configuration repo which should be cloned next to this project (no manual copying required). The variable can then be accessed in the dart code using functions like String.fromEnvironment("EMULATOR_IP", defaultValue: "");
Android Code Environment variables can also be accessed in native android code. The process for this is explained very well in this tutorial
iOS Code Environment variables can also be accessed in native ios code. The process is however not document very well. I researched it with a combination of these two tutorials. Tutorial 1, Tutorial 2.
In easy words, environment variables are accessible on the ios side as build settings. These, however, cannot be accessed directly. Instead one must again add the same variable to the info.plist file. Then oen can access the variable in code using Bundle.main.infoDictionary?["VARIABLE"]. Again for more information please refer to the tutorial or to Tim Lindenau.
List of all Environment Variables which must be set
| Variable | description | valid values |
|---|---|---|
| FIREBASE_ENVIRONMENT | Whether to use production backend or local emulator suite | local; production |
Now you are ready to start developing. Have fun and thanks for contributing :)
Releases are named using sematic versioning meaning, there are three different types of releases:
- Major release: A major release increments the first number. This is done when there are significant changes in the feature set of the App
- Minor Release: A minor release increments the second number. This is done when new functionality has been added to the App
- Patch release: A patch release increments the third number. This is done when only bugs have been fixed
To simplify the process of releasing, there is a Tools