Skip to content

Remove LoopFollow browser build instructions and point to LFDocs #1017

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
carolvchn wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remove LoopFollow browser build instructions and point to LFDocs #1017

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 8 additions & 52 deletions docs/browser/other-apps.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Once Loop 3 was released with the ability to build using a browser, a lot of oth
**Only apps that are companions to&nbsp;_<span translate="no">Loop</span>_&nbsp;are included on this page.**

* _<span translate="no">LoopCaregiver</span>_
* _<span translate="no">LoopFollow</span>_
* _<span translate="no">LoopFollow</span>_ LoopFollow build instructions have been moved to https://loopfollowdocs.org/build/lf-browser-build/

If you want to build another DIY app that is not included here, look for the file `fastlane/testflight.md` in the *GitHub* repository associated with that app and open it in a browser. The instructions for that app should be located in that file.

Expand All @@ -21,13 +21,6 @@ If you are coming to this page to update one of the other apps, follow the [How

**WARNING: starting May 2025, [Manual Action for Automatic Build](automatic.md#manual-action-for-automatic-build){: target="_blank" } may be required - be sure to check monthly to see if you need to start a build manually.**

### Multiple Copies of `LoopFollow`

For the convenience of caregivers who use `LoopFollow` to monitor multiple people, updates were added in v2.1.2 to make this more convenient. This works regardless of the build method. (Build with Browser or [Build with *Mac*](https://www.loopandlearn.org/loop-follow#lf-script){: target="_blank" }).

* Build up to three instances of `LoopFollow`
* Customize the name of the app that appears on your phone
* Display the custom name in the main `LoopFollow` screen

### Prerequisites

Expand All @@ -47,33 +40,14 @@ You will return to this page after reviewing (but not doing) this step [Configur

* Use the same method as that section, but <span>`fork` the `repository` for the app</span> you plan to build to your *GitHub* organization
* _<span translate="no">LoopCaregiver</span>_, expect the `dev branch`
* _<span translate="no">LoopFollow</span>_, expect the `main branch`


### Table of App `Repositories`

| App | Fork from this Address | Documentation |
|---|---|---|
| <span translate="no">LoopCaregiver</span> | [https://github.com/LoopKit/LoopCaregiver](https://github.com/LoopKit/LoopCaregiver) | [LoopDocs: <span translate="no">LoopCaregiver</span>](../nightscout/loop-caregiver.md) |
| <span translate="no">LoopFollow</span> | [https://github.com/loopandlearn/LoopFollow](https://github.com/loopandlearn/LoopFollow) | [<span translate="no">LoopFollow</span>](https://www.loopandlearn.org/loop-follow)|

??? tips "LoopFollow Builders: Display Name (Click to Open/Close)"
* Would you like the name of your LoopFollow app to be personalized?
* Do you have more than one Looper, so you are using LoopFollow_Second or LoopFollow_Third?
* The 3 LoopFollow repositories enable you to customize the name shown on your phone

After you `fork` your *LoopFollow* repository, find the file named: `LoopFollowDisplayNameConfig.xcconfig`

* Open it in your browser
* Follow the directions to change `display_name`
* "Save the file" means commit the change to your `main` branch
* It is recommended that you use LF_name, where name is the customized name - that way you can find it in an alphabetic list of apps

The two repositories below are only if you need to follow a second or third looper. All others should use just the table above. The instructions for the second and third looper are otherwise identical to the first looper. Note that `LoopCaregiver` can follow multiple Loopers; you select the person inside the app.

| Special Case | Fork from this Address |
|---|---|
| <span translate="no">LoopFollow for a Second Looper</span> | [https://github.com/loopandlearn/LoopFollow_Second](https://github.com/loopandlearn/LoopFollow_Second) |
| <span translate="no">LoopFollow for a Third Looper</span> | [https://github.com/loopandlearn/LoopFollow_Third](https://github.com/loopandlearn/LoopFollow_Third) |

## Configure <code>Secrets</code> for this App

Expand Down Expand Up @@ -131,11 +105,10 @@ The workflows are now displayed: look at the list on the left side similar to th

This step validates most of your six <code>Secrets</code> and provides error messages if it detects an issue with one or more.

1. Click on the "Actions" tab of your *LoopFollow* or *LoopCaregiver* repository and enable workflows if needed
1. Click on the "Actions" tab of your *LoopCaregiver* repository and enable workflows if needed
1. On the left side, click on 1. <code>Validate Secrets</code>
1. On the right side, click `Run Workflow` to show a dropdown menu
* You will see your default branch (`main` for LoopFollow, `dev` for LoopCaregiver)
* You can select a different branch, but typically, you run the default
* You will see your default branch (`dev`)
1. Tap the green button that says `Run workflow`.

![add identifiers using github actions](img/action-01-validate-secrets.svg){width="700"}
Expand All @@ -161,8 +134,7 @@ Refer to the graphic below for the numbered steps:
1. Click on the "Actions" tab of your repository
1. On the left side, click on "Add Identifiers"
1. On the right side, click "Run Workflow" to show a dropdown menu
* You will see your default branch (`main` for LoopFollow, `dev` for LoopCaregiver)
* You can select a different branch, but typically, you run the default
* You will see your default branch (`dev`)
1. Tap the green button that says "Run workflow"

![add identifiers using github actions](img/action-02-add-identifiers.svg){width="700"}
Expand All @@ -184,13 +156,10 @@ After successfully performing the `Add Identifiers Action`, you will see the ide
| App Name | Name | Bundle ID |
| --- | --- | --- |
| <span translate="no">LoopCaregiver</span> | <span translate="no">LoopCaregiver</span> | <span translate="no">com.TEAMID.loopkit.LoopCaregiver</span> |
| <span translate="no">LoopFollow</span> | <span translate="no">LoopFollow</span> | <span translate="no">com.TEAMID.LoopFollow</span> |

> If you build from a second or third `repository` for `LoopFollow`, the Name will end in `Second` or `Third` and Bundle ID will have `.Second` or `.Third` at the end.

The *LoopCaregiver* app requires updates to the `Identifiers` after they are generated. Skip ahead to [Add `App Group` to `LoopCaregiver`](#add-app-group-to-identifiers).

The *LoopFollow* Identifiers do not need special handling, so for *LoopFollow*, you can skip ahead to [Create App in App Store Connect](#create-app-in-app-store-connect)

## Add `App Group` to `LoopCaregiver`

Expand Down Expand Up @@ -302,9 +271,7 @@ This requires you to provide some information. Examine the table below for the b
| App Name | Bundle ID |
| --- | --- |
| <span translate="no">LoopCaregiver</span> | <span translate="no">com.TEAMID.loopkit.LoopCaregiver</span> |
| <span translate="no">LoopFollow</span> | <span translate="no">com.TEAMID.LoopFollow</span> |

> If you build from a second or third `repository` for `LoopFollow`, the Bundle ID will have `.Second` or `.Third` at the end.

1. Open this link: [App Store Connect / Apps](https://appstoreconnect.apple.com/apps) to view your apps; log in if needed.

Expand All @@ -315,7 +282,7 @@ This requires you to provide some information. Examine the table below for the b
{align="center"}

1. The New App dialog box opens and should appear similar to the graphic below. Before you fill anything out, make sure your Bundle ID is available in the dropdown menu. If you do not see the Bundle ID for your app; back out of this screen and follow the directions in [Configure to Use Browser: Find My Loop](prepare-app.md#find-my-loop), where you'll be finding App Name instead of Loop.
* Select "iOS". For LoopFollow you can also select "macOS" if you own a Mac with macOS 11 or later.
* Select "iOS"
* Enter a name: this will have to be unique
* You could start with "App Name ABC" where ABC are your initials
* If that is already taken, you can add a number, for example, "App Name ABC 123"
Expand Down Expand Up @@ -357,7 +324,7 @@ Refer to the graphic below for the numbered steps:
1. Click on the "Actions" tab of your Repository repository
1. On the left side, click on "Create Certificates"
1. On the right side, click "Run Workflow" to show a dropdown menu
* You will see your default branch (`main` for LoopFollow, `dev` for LoopCaregiver)
* You will see your default branch (`dev`)
* You can select a different branch, but typically, you run the default
1. Tap the green button that says "Run workflow".

Expand All @@ -376,17 +343,6 @@ The graphic below is an example from Loop, your screen will show your app and as

If you are building the *LoopCaregiver* app, skip ahead to [Build Action](#build-action).

### Display Name Customization for `LoopFollow`

> If you build `LoopFollow` for one, two or three loopers, you may choose to customize your `fork` or `forks` to insert a custom display name.

> * Find and click on the file `LoopFollowDisplayNameConfig.xcconfig`
> * Tap the pencil icon so you can edit the file
> * The last line says `display_name = LoopFollow` (or `LoopFollow_Second` or `LoopFollow_Third`)
> * Insert your custom name so the last line says `display_name = LF custom name`
> * Click on commit changes and chose to commit directly into the `main` branch

> Continue to build as instructed below. After you install the app on your phone, iPad or Mac via *TestFlight*, that custom name is what is displayed. The prefix LF is suggested to make it easier to find the custom named `LoopFollow` app in the list of apps, but is not required.

### Build Action

Expand All @@ -395,7 +351,7 @@ Refer to the graphic below for the first four steps:
1. Click on the "Actions" tab of your Repository repository.
1. On the left side, click on "Build *App Name*".
1. On the right side, click "Run Workflow" to show a dropdown menu
* You will see your default branch (`main` for LoopFollow, `dev` for LoopCaregiver)
* You will see your default branch (`dev`)
* You can select a different branch, but typically, you run the default
1. Tap the green button that says "Run workflow".

Expand Down