a mirror of DefinedNet/mobile_nebula
Go to file
Ian VanSchooten 8d5c86f318 Replace deprecated github release action 2024-10-25 08:54:48 -04:00
.github/workflows Replace deprecated github release action 2024-10-25 08:54:48 -04:00
android Fix Nebula reloading on managed update (#176) 2024-10-10 09:59:00 -04:00
fonts Initial commit 2020-07-27 15:43:58 -05:00
images Support DN host enrollment (#86) 2022-11-17 16:43:16 -05:00
ios Add Sentry for error tracking (#189) 2024-10-25 08:53:07 -04:00
lib Add Sentry for error tracking (#189) 2024-10-25 08:53:07 -04:00
nebula Add smoke-build CI workflow (#169) 2024-10-17 09:38:50 -04:00
.git-blame-ignore-revs git blame ignore that the format merge (#39) 2021-05-03 17:00:29 -05:00
.gitignore Rebind against nebula 1.6 for relays, modernize build (#63) 2022-08-04 19:39:46 -05:00
.metadata Initial commit 2020-07-27 15:43:58 -05:00
CHANGELOG.md Fix date 2021-06-09 20:31:00 -05:00
README.md Flutter format is removed, now dart format (#168) 2024-10-07 11:38:00 -04:00
env.sh.example Initial commit 2020-07-27 15:43:58 -05:00
gen-artifacts.sh Upgrade to flutter 3 (#70) 2022-09-21 15:27:35 -05:00
pubspec.lock Add Sentry for error tracking (#189) 2024-10-25 08:53:07 -04:00
pubspec.yaml Add Sentry for error tracking (#189) 2024-10-25 08:53:07 -04:00

README.md

Mobile Nebula

Play Store | App Store

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 select 26.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 with sudo 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