Mercury/openshock-android
1
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity
Companion app for managing openshock-compatible devices
35 commits 1 branch 2 tags 709 KiB
Dart 51.1%
C++ 28.6%
CMake 15.1%
HTML 2.8%
C 1.1%
Other 1.2%
Go to file
Mercurio acb254db14 iOS Build workflow, dependency bump
2023-12-20 21:00:22 +01:00
.github/workflows iOS Build workflow, dependency bump 2023-12-20 21:00:22 +01:00
.vscode Initial build 2023-11-09 19:23:46 +01:00
android icon fixes [ios/android] 2023-12-20 19:50:27 +01:00
ios icon fixes [ios/android] 2023-12-20 19:50:27 +01:00
lib iOS Build workflow, dependency bump 2023-12-20 21:00:22 +01:00
web Initial build 2023-11-09 19:23:46 +01:00
windows Initial build 2023-11-09 19:23:46 +01:00
.gitignore Toast on api request, reduced padding, maybe fixed building stuff 2023-11-10 11:13:24 +01:00
.metadata Initial build 2023-11-09 19:23:46 +01:00
analysis_options.yaml Initial build 2023-11-09 19:23:46 +01:00
LICENSE Initial commit 2023-11-09 17:32:57 +01:00
pubspec.lock iOS Build workflow, dependency bump 2023-12-20 21:00:22 +01:00
pubspec.yaml iOS Build workflow, dependency bump 2023-12-20 21:00:22 +01:00
README.md iOS Build workflow, dependency bump 2023-12-20 21:00:22 +01:00

README.md

Openshock Mobile Companion

Companion app for managing openshock-compatible devices

Minimum supported Android API: 31 (Android 12). Minimum required iOS version: 14

lang os1 os1

Flutter application to manage and control openshock devices from your phone.

Current build status(android): Nightly Android

Current build status(iOS): Nightly iOS

Installing

Stable release channel

Grab one of the builds from the releases page or run:

flutter build apk

Production artifacts will be found in the build\app\outputs\apk\ directory.

RRC (Rolling Release Channel)

There's also a Rolling release available as a GitHub Actions artifact. It runs every time I commit, so it might be up to date but also potentially broken.

Building for Android

Make sure you have Flutter, Android Studio, and Visual Studio Code installed. Install the suggested Flutter, Dart, and linting extensions in Visual Studio Code.

Run the following commands to ensure all dependencies are met:

flutter doctor

You'll be guided through a first-time setup that checks for platform tools, dependencies, and missing components.

Once the setup is complete you can navigate to the repo folder and run

flutter run

If you want to build debug you can also run

flutter build apk --debug

Build artifacts for Android are saved under build\app\outputs\apk.

Building for iOS (manual installation required)

Make sure you have Flutter, xCode and Apple Developer Tools, cocoapods, and Visual Studio Code installed. Install the suggested Flutter, Dart, and linting extensions in Visual Studio Code and set up xcode for "iOS on iphone" developement. Once that is done, go in the project's folder and run the following command to ensure that your build environment is properly configured, any missing component will be highlighted

flutter doctor

Once you've done that, from the same terminal, run this command to generate a .IPA file - once you're done it's a matter of sideloading it to your device. since i've never owned an apple device i have no idea how to do that. iOS artifacts are saved in build/ios/runner/

flutter build ios --debug