Skip to content

Commit 3c953d1

Browse files
committed
document firebase config file
1 parent 557aedb commit 3c953d1

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

docs/development.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616

1717
- Windows 11 Or MacOS Sonoma (Have not tried developing on linux)
1818
- [Android Studio](https://developer.android.com/studio)
19-
- [Flutter Plugin](https://plugins.jetbrains.com/plugin/9212-flutter)
20-
- [Dart Plugin](https://plugins.jetbrains.com/plugin/6351-dart)
21-
- [Flutter Enhancement Suite (Recommended)](https://plugins.jetbrains.com/plugin/12693-flutter-enhancement-suite)
19+
- [Flutter Plugin](https://plugins.jetbrains.com/plugin/9212-flutter)
20+
- [Dart Plugin](https://plugins.jetbrains.com/plugin/6351-dart)
21+
- [Flutter Enhancement Suite (Recommended)](https://plugins.jetbrains.com/plugin/12693-flutter-enhancement-suite)
2222
- [Java `17` (For Android)](https://adoptium.net/temurin/releases/?package=jdk&version=17)
2323
- [XCode `16` (For IOS)](https://developer.apple.com/xcode/) with IOS & CLI Tools installed
2424
- [CocoaPods (For IOS)](https://cocoapods.org/)
@@ -43,11 +43,17 @@ When [`translation_string_definitions.dart`](lib/Frontend/translation_string_def
4343

4444
When non EN translations are updated in [Weblate](https://weblate.stargazer.at/projects/the-tailcompany-app/tailapp/), A pull request will automatically open with the changes. This may take a few minutes.
4545

46-
4746
### Fastlane
4847

4948
[Fastlane](https://docs.fastlane.tools/) is a tool to automatically upload apps to the Apple App Store and Google Play Store. Inside the [IOS](ios/) and [Android](android/) folders is a fastlane folder. Inside is the FastFile which contains the upload config. Secrets are JSON files passed through repository secrets. The script [fastlane.sh](Scripts/fastlane.sh) selects the fastlane folder to use and begins the upload.
5049

50+
### Firebase
51+
52+
This project uses 2 seperate Firebase projects. One for notifications and one for CosHub posts.
53+
54+
Notifications use `DefaultFirebaseOptions` in [`/lib/firebase_options.dart`](../lib/firebase_options.dart) while CosHub uses `CosHubFirebaseOptions`. This combined file was created by running `flutterfire configure` for CosHub, renaming the file, running the command again for tailApp, and then copying `DefaultFirebaseOptions` from coshub into the final [`/lib/firebase_options.dart`](../lib/firebase_options.dart) file.
55+
56+
This file is supplied in build via secrets.
5157

5258
### Repository Integrations
5359

@@ -91,6 +97,8 @@ To Turn off Developer Mode
9197
These services are self-hosted in a mini-pc on my tv stand in my apartment
9298

9399
[Plausible](https://plausible.codel1417.xyz/tail-app)
100+
[Aptabase](https://aptabase.codel1417.xyz/)
101+
[Sentry](https://sentry.codel1417.xyz/)
94102
[Uptime](https://uptime.codel1417.xyz/status/public)
95103

96104
#### Infrastructure notes
@@ -113,4 +121,4 @@ The file is included in builds and updated after app launch, so changes may not
113121

114122
### Misc
115123

116-
UUIDs were generated using https://www.uuidgenerator.net/version4
124+
UUIDs were generated using <https://www.uuidgenerator.net/version4>

0 commit comments

Comments
 (0)