mobile_nebula/README.md

# Mobile Nebula

[Play Store](https://play.google.com/store/apps/details?id=net.defined.mobile_nebula&hl=en_US&gl=US) | [App Store](https://apps.apple.com/us/app/mobile-nebula/id1509587936)

## Setting up dev environment

Install all of the following things:

- [`xcode`](https://apps.apple.com/us/app/xcode/)
- [`android-studio`](https://developer.android.com/studio)
- [`flutter` 3.27.0](https://docs.flutter.dev/get-started/install)
- [`gomobile`](https://pkg.go.dev/golang.org/x/mobile/cmd/gomobile)
- [Flutter Android Studio Extension](https://docs.flutter.dev/get-started/editor?tab=androidstudio)

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 `27.0.12077973` version.
- Ensure you have downloaded a 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:
```sh
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.

# Prerelease

Push a git tag `v#.#.#-##`, e.g. `v0.5.2-0`, and `.github/release.yml` will build a draft release and publish it to iOS TestFlight and Android internal track.


# Release

We manually promote a prerelease build from TestFlight and Android internal track to the public app stores, and then mark the associated draft release as published, removing the `-##` from it.
Add app store links (#111) 2023-04-04 14:54:37 +00:00			`# Mobile Nebula`

			`[Play Store](https://play.google.com/store/apps/details?id=net.defined.mobile_nebula&hl=en_US&gl=US) \| [App Store](https://apps.apple.com/us/app/mobile-nebula/id1509587936)`

Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00			`## Setting up dev environment`
Add a first cut readme 2020-12-07 21:10:31 +00:00
Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00			`Install all of the following things:`

			- [`xcode`](https://apps.apple.com/us/app/xcode/)
Update README.md and pubspec.lock 2020-12-10 17:06:40 +00:00			- [`android-studio`](https://developer.android.com/studio)
Update to flutter 3.27 (#214) The main thing here is that it will support edge-to-edge when we target android 15, and it changes the default for deep links. The update to mobile_scanner should improve ios simulator support, but I'm finding that the app still won't load in the simulator (even without mobile_scanner at all), so there's some other work to do there. https://medium.com/flutter/whats-new-in-flutter-3-27-28341129570c 2025-01-10 17:13:48 +00:00			- [`flutter` 3.27.0](https://docs.flutter.dev/get-started/install)
Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00			- [`gomobile`](https://pkg.go.dev/golang.org/x/mobile/cmd/gomobile)
			`- [Flutter Android Studio Extension](https://docs.flutter.dev/get-started/editor?tab=androidstudio)`

			`Ensure your path is set up correctly to execute flutter`
Update README.md and pubspec.lock 2020-12-10 17:06:40 +00:00
Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00			Run `flutter doctor` and fix everything it complains before proceeding
Minor tweaks for a clean build - Updated README with some maybe-helpful instructions for downgrading flutter to a version that will build the project - Added a step to create a missing directory to the Gradle build (otherwise the build fails) - Set `shrinkResources false` - otherwise you get an error that you can't shrink resources unless you also enable minifying 2021-04-22 22:46:16 +00:00
Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00			NOTE on iOS, always open `Runner.xcworkspace` and NOT the `Runner.xccodeproj`
Update README.md and pubspec.lock 2020-12-10 17:06:40 +00:00
Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00			`### Before first compile`
Update README.md and pubspec.lock 2020-12-10 17:06:40 +00:00
Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00			- Copy `env.sh.example` and set it up for your machine
			- Ensure you have run `gomobile init`
Update README with release instructions and spelling changes 2025-02-04 18:18:35 +00:00			- 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 `27.0.12077973` version.
			`- Ensure you have downloaded a NDK via android studio, this is likely not the default one, and you need to check the`
Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00			`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`
Update README with release instructions and spelling changes 2025-02-04 18:18:35 +00:00			- If on macOS arm, `sudo gem install ffi -- --enable-libffi-alloc`
Upgrade to flutter 3 (#70) Co-authored-by: John Maguire <contact@johnmaguire.me> 2022-09-21 20:27:35 +00:00
			If you are having issues with iOS pods, try blowing it all away! `cd ios && rm -rf Pods/ Podfile.lock && pod install --repo-update`
Add a first cut readme 2020-12-07 21:10:31 +00:00
			`# Formatting`

Flutter format is removed, now dart format (#168) It was removed in 3.12: https://github.com/flutter/flutter/pull/129360 This updates the README and our CI job. 2024-10-07 15:38:00 +00:00			`dart format` can be used to format the code in `lib` and `test`. We use a line-length of 120 characters.
Add a first cut readme 2020-12-07 21:10:31 +00:00
			`Use:`
			```sh
Flutter format is removed, now dart format (#168) It was removed in 3.12: https://github.com/flutter/flutter/pull/129360 This updates the README and our CI job. 2024-10-07 15:38:00 +00:00			`dart format lib/ test/ -l 120`
Update README.md and pubspec.lock 2020-12-10 17:06:40 +00:00			```

Update README with release instructions and spelling changes 2025-02-04 18:18:35 +00:00			`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.`
Flutter format is removed, now dart format (#168) It was removed in 3.12: https://github.com/flutter/flutter/pull/129360 This updates the README and our CI job. 2024-10-07 15:38:00 +00:00
Update README with release instructions and spelling changes 2025-02-04 18:18:35 +00:00			`# Prerelease`
Flutter format is removed, now dart format (#168) It was removed in 3.12: https://github.com/flutter/flutter/pull/129360 This updates the README and our CI job. 2024-10-07 15:38:00 +00:00
Update README with release instructions and spelling changes 2025-02-04 18:18:35 +00:00			Push a git tag `v#.#.#-##`, e.g. `v0.5.2-0`, and `.github/release.yml` will build a draft release and publish it to iOS TestFlight and Android internal track.
Add a first cut readme 2020-12-07 21:10:31 +00:00

Update README with release instructions and spelling changes 2025-02-04 18:18:35 +00:00			`# Release`
Add a first cut readme 2020-12-07 21:10:31 +00:00
Update README with release instructions and spelling changes 2025-02-04 18:18:35 +00:00			We manually promote a prerelease build from TestFlight and Android internal track to the public app stores, and then mark the associated draft release as published, removing the `-##` from it.