Skip to content

BrowserBuild.md

Latest commit

 

History

History
68 lines (44 loc) · 3 KB

BrowserBuild.md

File metadata and controls

68 lines (44 loc) · 3 KB
Raw

(browser-build)=

Browser build

Building AAPS with GitHub Actions.

Minimum AAPS version supported is 3.3.2.1.

Build yourself instead of download

The AAPS app (an apk file) is not available for download, due to regulations around medical devices. It is legal to build the app for your own use, but you must not give a copy to others!

See FAQ page for details.

(Building-APK-without-a-computer)=

Device and software specifications for building AAPS

We recommend using an Android device. You can also use a computer or an iOS device.

You will need to use multiple tabs in your browser, and switch from one to the other. Example Chrome:

fork_aaps

You also need a Google account so that the app can be saved in your Google Drive.

This wiki assumes you're performing all operations with your cellular phone and the Chrome web browser.  
You will need to jump from tab to tab: start with all tabs closed to avoid losing yourself when switching from one to another.

What you'll need

  • A Google account, so the built app can be saved to your Google Drive (needed on every device).
  • A GitHub account (free) – you create this in Step 1.
  • A web browser that can keep several tabs open at once (Chrome is assumed below).
  • A small helper to run the preparation file. Which one you need depends on the device you build from – there is nothing to install now, Step 2 walks you through it for your device:
    • Android: File Manager Plus (from the Play Store).
    • Computer (Windows / Mac / Linux): Simple HTTP Server.
    • iPhone / iPad: no extra app – you use the built-in Files app and browser.
On Android, also make sure the **Google Drive app is up to date** (via the Play Store) so you can download the finished app afterwards.

The steps

The browser build is a series of choices. Follow these steps in order:

  1. Create your GitHub fork – make your personal copy of the AAPS source code.
  2. Create your signing keystore – the key decision: generate a new keystore (Option 1) or upload your existing one (Option 2), then follow the page for your device.
  3. Authorize Google Drive – let GitHub save the built app to your Google Drive.
  4. Build the APK – run the GitHub Actions workflow and pick your version and variant.

If you run into trouble, see Browser build troubleshooting. For optional operations, see exporting your keystore or cherry-picking a commit.

Start with Step 1 – Create your GitHub fork →

:hidden:

Step 1: Create your fork <BrowserBuildFork.md>
Step 2: Create your keystore <BrowserBuildKeystore.md>
Step 3: Authorize Google Drive <BrowserBuildGoogleDrive.md>
Step 4: Build the APK <BrowserBuildAPK.md>