You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: README.md
+33-28
Original file line number
Diff line number
Diff line change
@@ -38,56 +38,55 @@ flutter:
38
38
39
39
Command to run to update the translations
40
40
```
41
-
flutter packages pub run icapps_translations
41
+
fvm flutter packages pub run icapps_translations
42
42
```
43
43
44
44
## Json Serializable & Kiwi
45
45
46
46
```
47
-
flutter packages pub run build_runner build
48
-
flutter packages pub run build_runner build --delete-conflicting-outputs
49
-
flutter packages pub run build_runner watch
47
+
fvm flutter packages pub run build_runner build --delete-conflicting-outputs
48
+
fvm flutter packages pub run build_runner watch
50
49
```
51
50
## Environments
52
51
53
52
`--release` is not available for emulators. Performance will be better
54
53
55
54
### Dev, Debug
56
55
```
57
-
flutter run --flavor dev -t lib/main.dart
56
+
fvm flutter run --flavor dev -t lib/main.dart
58
57
59
-
flutter run --release --flavor dev -t lib/main.dart
58
+
fvm flutter run --release --flavor dev -t lib/main.dart
60
59
```
61
60
62
61
### Dummy
63
62
64
63
Note: a hot reload is required after launch to use the correct launch file.
65
64
66
65
```
67
-
flutter run --flavor dev -t lib/main_dummy.dart
66
+
fvm flutter run --flavor dev -t lib/main_dummy.dart
68
67
69
-
flutter run --release --flavor dev -t lib/main_dummy.dart
68
+
fvm flutter run --release --flavor dev -t lib/main_dummy.dart
70
69
```
71
70
72
71
### Alpha
73
72
```
74
-
flutter run --flavor alpha -t lib/main_alpha.dart
73
+
fvm flutter run --flavor alpha -t lib/main_alpha.dart
75
74
76
-
flutter run --release --flavor alpha -t lib/main_alpha.dart
75
+
fvm flutter run --release --flavor alpha -t lib/main_alpha.dart
77
76
```
78
77
79
78
### Beta
80
79
```
81
-
flutter run --flavor beta -t lib/main_beta.dart
80
+
fvm flutter run --flavor beta -t lib/main_beta.dart
82
81
83
-
flutter run --release --flavor beta -t lib/main_beta.dart
82
+
fvm flutter run --release --flavor beta -t lib/main_beta.dart
84
83
```
85
84
86
85
### Prod, Release
87
86
```
88
-
flutter run --flavor prod -t lib/main_prod.dart
87
+
fvm flutter run --flavor prod -t lib/main_prod.dart
89
88
90
-
flutter run --release --flavor prod -t lib/main_prod.dart
89
+
fvm flutter run --release --flavor prod -t lib/main_prod.dart
91
90
```
92
91
93
92
## Niddler
@@ -100,7 +99,7 @@ Niddler is also available for Android & Java (OkHttp: https://github.com/icapps/
100
99
101
100
## Linting
102
101
103
-
To check your code matches our linting. The analysis_options.yaml contains all our code checks.
102
+
To check your code matches our linting. The `analysis_options.yaml` contains all our code checks.
104
103
105
104
```
106
105
flutter analyze
@@ -111,13 +110,13 @@ flutter analyze
111
110
In order to run our test we need to run
112
111
113
112
```
114
-
flutter test
113
+
fvm flutter test
115
114
```
116
115
117
116
If we want to update our golden files we need to run
118
117
119
118
```
120
-
flutter test --update-goldens
119
+
fvm flutter test --update-goldens
121
120
```
122
121
123
122
## Fastlane
@@ -135,15 +134,21 @@ This script will run a dart script. The dart script itself will ask you some inp
135
134
136
135
#### Add provisioning files
137
136
138
-
```
139
-
place the provisioning profiles -> provision_profile/**
140
-
naming should be the same as provided in the iOS/Configuration/** files (underscore will be replaced with a space in the configuration files)
141
-
```
137
+
Add the provisioning profiles in the ios/provisioning/ folder. The naming of the files should be the same as provided in the `ios/Configuration/{flavor}.xcconfig` files (underscore will be replaced with a space in the configuration files)
138
+
139
+
#### Firebase
140
+
141
+
To setup firebase you will need to create a new firebase project with 8 new apps, 1 for each flavor on both iOS and Android.
142
+
143
+
When creating the iOS apps on firebase you will be able to download a `GoogleService-Info.plist` file which you will need to rename according to the flavor you just created an app for e.g.: You just created the iOS App for the Dev flavor so your file should be named `GoogleService-Info-dev.plist`.
144
+
Each `.plist` file you download from firebase needs to be placed in the ios/Configuration/GoogleService/ folder. Whenever the project is run with a different flavor from the currently active flavor, it will automatically copy the correct `GoogleService-Info-{flavor}.plist` file into the ios/Runner/ folder.
145
+
146
+
When creating the Android apps you will be able to download a `google-services.json` file, you only need to download this file once at the end of the last Android app setup on firebase. This `.json` file contains all the configurations for the 4 Android apps which you just created. Add the `.json` file in the android/app/src/ folder.
142
147
143
148
#### Languages
144
149
145
150
```
146
-
Configure the required languages in xCode
151
+
Configure the required languages in Xcode
147
152
```
148
153
149
154
### icapps Translations
@@ -157,34 +162,34 @@ Update the translations.py file (edit the todos)
157
162
Obfuscation is enabled by default when using fastlane for building. The symbol files are stored in
158
163
`./build/debug-info/#{options[:flavor]}`
159
164
160
-
**Important**: Add the following regex to jenking configuration to also archive the symbol files
165
+
**Important**: Add the following regex to jenkins configuration to also archive the symbol files
161
166
```
162
167
**/*.symbols
163
168
```
164
169
165
170
### Icons
166
171
167
-
Replace the files in assets_launcher_icons/
172
+
Replace the files in the `assets_launcher_icons/**` folder.
168
173
169
-
You can also change the adaptive_icon_background in the flutter_launcher_icons-{flavor}.yaml (currently "#CB2E63") (only available for Android 8.0 devices and above)
174
+
You can also change the adaptive_icon_background in the `flutter_launcher_icons-{flavor}.yaml` (currently "#CB2E63") (only available for Android 8.0 devices and above)
170
175
171
176
After this, run the following command
172
177
173
178
```
174
-
flutter pub run flutter_launcher_icons:main -f flutter_launcher_icons-dev.yaml
179
+
fvm flutter pub run flutter_launcher_icons:main -f flutter_launcher_icons-dev.yaml
175
180
```
176
181
177
182
### Common issues
178
183
179
184
```
180
-
No Flavor provided
185
+
No flavor provided
181
186
```
182
187
183
188
Add a flavor to your configuration. Extra info can be found in this issue -> https://github.com/icapps/flutter-template/issues/3
0 commit comments