From d95b811d6ca64de1a31ec412e95d1ba7d1d4eaa4 Mon Sep 17 00:00:00 2001
From: Vadim <44135514+vodemn@users.noreply.github.com>
Date: Mon, 17 Mar 2025 21:35:33 +0100
Subject: [PATCH] Added script to setup the repo & updated README.md (#223)

* added script to setup the repo

* moved scripts to scripts folder

* Update README.md

* added macOS disclaimer
---
 README.md                                     | 43 ++++---------------
 scripts/setup_fork.sh                         | 16 +++++++
 test_coverage.sh => scripts/test_coverage.sh  |  0
 .../update_goldens.sh                         |  0
 4 files changed, 24 insertions(+), 35 deletions(-)
 create mode 100644 scripts/setup_fork.sh
 rename test_coverage.sh => scripts/test_coverage.sh (100%)
 rename update_goldens.sh => scripts/update_goldens.sh (100%)

diff --git a/README.md b/README.md
index cfc5446..6106e46 100644
--- a/README.md
+++ b/README.md
@@ -38,41 +38,18 @@ To build this app you need to install Flutter 3.24.5 stable. [How to install](ht
 
 ### 2. Project setup
 
-#### Restore _constants.dart_ file
+#### Restore git-ignored files:
 
-Create a file _lib/constants.dart_ and paste the following content:
-
-```dart
-const String contactEmail = '';
-const String iapServerUrl = '';
-const String issuesReportUrl = '';
-const String sourceCodeUrl = '';
-```
-
-#### Stub IAP package
-
-As part of the app's functionallity is in the private repo, you have to replace these lines in _pubspec.yaml_:
-
-```yaml
-m3_lightmeter_iap:
-  git:
-    url: "https://github.com/vodemn/m3_lightmeter_iap"
-    ref: main
-```
-
-with these:
-
-```yaml
-m3_lightmeter_iap:
-  path: iap
-```
-
-You can do it simply by running the script:
+For macOS you can just run the following script:
 
 ```console
-sh .github/scripts/stub_iap.sh
+sh scripts/setup_fork.sh
 ```
 
+Or create the files manually using the contents from the script.
+
+#### Get dependencies
+
 > If you are using VSCode, you can open the workspace like so: _File -> Open Workspace from File -> m3_lightmeter.code-workspace_. Otherwise you have to run `flutter pub get` command from the iap folder.
 
 Then you can fetch all the neccessary dependencies and generate translation files by running the following commands:
@@ -82,11 +59,7 @@ flutter pub get
 flutter pub run intl_utils:generate
 ```
 
-### 3. (Optional) Install Firebase
-
-Out of the box Firebase Crashlytics won't work. If you want to add Crashlytics to your local build please follow [this guide](https://firebase.google.com/docs/flutter/setup).
-
-### 4. Build
+### 3. Build
 
 - Checkout [Build .apk](.github/workflows/build_apk.yml) workflow for Android
 - Checkout [Build .ipa](.github/workflows/build_ipa.yml) workflow for iOS
diff --git a/scripts/setup_fork.sh b/scripts/setup_fork.sh
new file mode 100644
index 0000000..1de63df
--- /dev/null
+++ b/scripts/setup_fork.sh
@@ -0,0 +1,16 @@
+constants="const String contactEmail = '';
+const String iapServerUrl = '';
+const String issuesReportUrl = 'https://github.com/vodemn/m3_lightmeter/issues/new/choose';
+const String sourceCodeUrl = 'https://github.com/vodemn/m3_lightmeter/';"
+
+firebase_options="// ignore_for_file: type=lint
+import 'package:firebase_core/firebase_core.dart' show FirebaseOptions;
+
+class DefaultFirebaseOptions {
+  static FirebaseOptions get currentPlatform =>
+      FirebaseOptions(apiKey: '', appId: '', messagingSenderId: '', projectId: '');
+}"
+
+echo "$constants" > "lib/constants.dart"
+echo "$firebase_options" > "lib/firebase_options.dart"
+sh .github/scripts/stub_iap.sh
diff --git a/test_coverage.sh b/scripts/test_coverage.sh
similarity index 100%
rename from test_coverage.sh
rename to scripts/test_coverage.sh
diff --git a/update_goldens.sh b/scripts/update_goldens.sh
similarity index 100%
rename from update_goldens.sh
rename to scripts/update_goldens.sh