Improving docs for new comers

[hassan-saleh-ml]

For new devs that are trying to run the template, the docs are not very straightforward.

For example, in this step:

Execute a run configuration of choice

• $ flutter run --flavor staging -t lib/main_staging.dart
• $ flutter run --flavor production -t lib/main_production.dart

It is suggesting to use a flavor, I'm assuming this is here because it's a template and will be used for an actual app that does have flavors, however the template app does not have any Android or iOS flavors and to run the app you have to use:

• $ flutter run -t lib/main_staging.dart
• $ flutter run -t lib/main_production.dart

Maybe we can add a disclaimer to remove the flavor if you're doing development on the template, or we can add the the flavors (Not sure if this is a good idea for a template).

Another thing is that code generation step is missing, I did figure this out on my own, however some junior devs might not, I suggest we add it.

Execute $ flutter pub run build_runner build to generate the required files

Also, code generation caused conflicts with some files for some reason, I had to run $ flutter pub run build_runner build --delete-conflicting-outputs to re-generate those files.

Something worth mentioning:

The Flutter version to be used is not mentioned, I have Flutter v3.7.8 installed and faced an issue when first trying to run the code generation command, the first thing I usually do in such a case is to remove the pubspec.lock file, run a $ flutter clean command, sometimes I also delete some generated iOS and android files, and then run flutter pub get again.

This solved the issue for me, it would be a good idea to add a debugging section for juniors to avoid unnecessary questions.

[hassan-saleh-ml]

Maybe we can add some documentation about some of the packages we use and how we use them:

1. Freezed
2. Auto route
3. Retrofit
4. Injectable
5. Logging
6. Nstack
7. Maybe some guidelines for how we write code