From bcbda5a6d00e1ba4b4699a81e0245f04db3c1a2b Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Sat, 11 Dec 2021 19:55:14 -0800 Subject: [PATCH] fix(README): Adding instructions to README for building Android app --- README.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README.md b/README.md index c81a149..e45daaf 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,20 @@ Standard workflow for setting up a development environment for working on this r - `npm install` - `npm start` +## Compiling Android App + +Hooks are provided for compiling this code base into an Android App using [Capacitor](https://capacitorjs.com/). It's possible to use this code to also compile an iOS app, but it is untested. Here is the flow for building the Android app: + +- Follow the instructions above to install the Dev Environment +- Download and install [Android Studio](https://developer.android.com/studio) +- Update the capacitor.config file with the route where Android studio is installed. +- `npm run build` (generates the public folder) +- `npm run android:setup` (generates the android folder) +- `npm run android:open` (opens the android studio with the project) +- Compile the APK with Android Studio. + +Note: The `gcradle` and `sdk` versions must be compatible. + ## License [MIT](./LICENSE.md)