GitJournal/BUILD.md

Building Instructions

• It's best to just work on this on Android - the ios setup is far more complicated and I haven't managed to automate it.

Environment Setup

1. Install Flutter through official guidilines

2. As a part of flutter installation, you will need to install Android Studio

3. Use AVD manager from Android Studio, to create device for local development.

4. Project contains :git_binding dependency, so it needs Android NDK. You need to install through SDK Manager. GitJournal has only been tested with NDK release 19. It would be best to install that.

5. Run the scripts/setup_env.dart script

6. Run command flutter run --flavor dev --debug: it will connect to available device and run program.

   1. Or you can run flutter build apk --flavor dev --debug and see apk under build/app/outputs/apk/ folder

7. You will see application on emulator, you are all setup. You can start with app.dart file to exploring code.

Trouble Shooting

Build fails on project git_bindings with a NullPointerException:

FAILURE: Build failed with an exception.

* What went wrong:
A problem occurred configuring project ':git_bindings'.
> java.lang.NullPointerException (no error message)

* Try:
Run with --stacktrace option to get the stack trace. Run with --info or --debug option to get more log output. Run with --scan to get full insights.

* Get more help at https://help.gradle.org

Try if changing the version of com.android.tools.build:gradle in the buildscript dependencies of android/build.gradle:13 from

classpath 'com.android.tools.build:gradle:3.3.2'

to

classpath 'com.android.tools.build:gradle:3.5.0'

fixes your issue.

IDE Setup

VS Code has great plugin for flutter, but you need to add args to launch.json. Example launch.json:

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Flutter",
            "request": "launch",
            "type": "dart",
            "args": ["--flavor", "dev"]
        }
    ]
}