c770ae7e1a | ||
---|---|---|
.github/workflows | ||
android | ||
fonts | ||
images | ||
ios | ||
lib | ||
nebula | ||
.git-blame-ignore-revs | ||
.gitignore | ||
.metadata | ||
CHANGELOG.md | ||
README.md | ||
env.sh.example | ||
gen-artifacts.sh | ||
pubspec.lock | ||
pubspec.yaml |
README.md
Mobile Nebula
Setting up dev environment
Install all of the following things:
Ensure your path is set up correctly to execute flutter
Run flutter doctor
and fix everything it complains before proceeding
NOTE on iOS, always open Runner.xcworkspace
and NOT the Runner.xccodeproj
Before first compile
- Copy
env.sh.example
and set it up for your machine - Ensure you have run
gomobile init
- In Android Studio, make sure you have the current ndk installed by going to Tools -> SDK Manager, go to the SDK Tools tab, check the
Show package details
box, expand the NDK section and select26.1.10909125
version. - Ensure you have downloaded an ndk via android studio, this is likely not the default one and you need to check the
Show package details
box to select the correct version. The correct version comes from the error when you try and compile - Make sure you have
gem
installed withsudo gem install
- If on MacOS arm,
sudo gem install ffi -- --enable-libffi-alloc
If you are having issues with iOS pods, try blowing it all away! cd ios && rm -rf Pods/ Podfile.lock && pod install --repo-update
Formatting
dart format
can be used to format the code in lib
and test
. We use a line-length of 120 characters.
Use:
dart format lib/ test/ -l 120
In Android Studio, set the line length using Preferences -> Editor -> Code Style -> Dart -> Line length, set it to 120. Enable auto-format with Preferences -> Languages & Frameworks -> Flutter -> Format code on save.
Release
Update version
in pubspec.yaml
to reflect this release, then
Android
flutter build appbundle
This will create an android app bundle at build/app/outputs/bundle/release/
Upload the android bundle to the google play store https://play.google.com/apps/publish
iOS
In xcode, Release -> Archive then follow the directions to upload to the app store. If you have issues, https://flutter.dev/docs/deployment/ios#create-a-build-archive