| 1 | --- |
| 2 | title: The phone app |
| 3 | description: g1t on Android and iOS, built with Expo. Highly experimental and barely working yet. Android first, downloaded from g1t.sh while it waits for Google Play. |
| 4 | --- |
| 5 | |
| 6 | The phone app is meant to be g1t on Android and iOS, with its own |
| 7 | screens for what you do away from a desk: triaging and discussing |
| 8 | [work items](/guides/work-items/) in Work, talking with your team in |
| 9 | Chat, with notifications on your phone, and reviewing pull requests in |
| 10 | Code. Everything else opens on the site, in your phone's browser. |
| 11 | |
| 12 | :::caution[Highly experimental] |
| 13 | The phone app is early and barely works yet: expect missing screens, |
| 14 | rough edges and things that break. For real work, use |
| 15 | [the desktop app](/guides/desktop/) or g1t in your phone's browser. |
| 16 | ::: |
| 17 | |
| 18 | ## Install it |
| 19 | |
| 20 | Android comes first. Get it from [g1t.sh/download](https://g1t.sh/download): |
| 21 | the page opens on **Android** when you visit it on an Android phone, and |
| 22 | [g1t.sh/download?platform=android](https://g1t.sh/download?platform=android) |
| 23 | opens it from anywhere. |
| 24 | |
| 25 | 1. On your Android phone, choose **Download for Android**. On a computer, |
| 26 | scan the code beside it with the phone's camera instead. |
| 27 | 2. Open the downloaded file. Android asks once to allow your browser to |
| 28 | install apps: allow it. If Play Protect warns about an unknown app, |
| 29 | choose **More details**, then **Install anyway**. |
| 30 | 3. Open **g1t** and choose **Sign in with g1t**. |
| 31 | |
| 32 | Point at the file's name on the page to see its SHA-256, to check the file |
| 33 | you have is the one g1t published. Like every g1t build during the alpha, |
| 34 | the app isn't code-signed yet, which is why Android warns |
| 35 | ([unsigned during the alpha](/guides/desktop/#unsigned-during-the-alpha)). |
| 36 | |
| 37 | **Why a download, and not Google Play?** Google Play and the App Store |
| 38 | publish a company's apps only once it is verified with a D-U-N-S number, |
| 39 | and Flagon's is on its way. Until then the Android app is published on |
| 40 | g1t.sh, as [the desktop app](/guides/desktop/) is. It moves |
| 41 | into Google Play as soon as it can. iOS has no way in but the App Store, |
| 42 | so it follows then. |
| 43 | |
| 44 | **Updates** reach the app by themselves: most arrive the next time you |
| 45 | open it, with nothing to install. A change that needs a new install is a |
| 46 | new release on the download page; installing it over the one you have |
| 47 | keeps you signed in. |
| 48 | |
| 49 | The bar along the bottom is the site's phone bar: |
| 50 | |
| 51 | | Tab | What is on it | |
| 52 | | --- | --- | |
| 53 | | **Home** | Coming. Opens Home on the site meanwhile. | |
| 54 | | **Work** | The workspace's work items, for every member, Code access or not. See [Work](#work). | |
| 55 | | **Chat** | Your starred conversations, channels and direct messages, with what is unread, moving live. See [Chat](#chat). | |
| 56 | | **Notifications** | Coming. Opens your notifications on the site meanwhile; messages to you already arrive [on the phone](#notifications). | |
| 57 | | **More** | **Code**, for members with Code access; whether this phone gets notifications, your workspaces, how you signed in, and **Sign out**. | |
| 58 | |
| 59 | **Code**, under **More**, is the workspace's repositories, each with its |
| 60 | pull requests and its **Work**: the work items linked to it. A pull |
| 61 | request shows its description, checks, conversation and changed files, |
| 62 | and you can approve it or ask for changes. |
| 63 | |
| 64 | ## Work |
| 65 | |
| 66 | Work on the phone is the site's [Work](/guides/work-items/), laid out for |
| 67 | one hand. |
| 68 | |
| 69 | - **The list** shows the workspace's open work items, newest first: each |
| 70 | with its number, title, state, labels and the repositories it is linked |
| 71 | to, which fold into "+2" past the first few. Pull down to read it |
| 72 | again; it loads more as you near its end. |
| 73 | - **Filters** are in a sheet: tap the filter button in the header, a |
| 74 | filter's chip above the list, or **Work** in the bar again. Choose the |
| 75 | state, **Assigned to me**, a label, a milestone, a repository and its role. |
| 76 | - **A work item** shows its description and comments (in Markdown, with |
| 77 | `#123` references opening what they name), its labels, milestone and |
| 78 | assignees, and under them its repositories: each with its role, its pull |
| 79 | requests for the item and whether the work **landed** there, and which |
| 80 | targets are still missing. **Suggested** repositories can be added as |
| 81 | targets with a tap. |
| 82 | - **The bar at its foot** comments. Its **⋯** closes the work item (as |
| 83 | done, or as not planned), reopens it, links a repository as a target, |
| 84 | copies its link, or opens it on the site. Tap a repository to open it or |
| 85 | unlink it. |
| 86 | - **New work item** (the **+** on Work) takes a title, a description, |
| 87 | labels and the repositories it should land in; none is fine. Opened from |
| 88 | a repository's Work, that repository is its origin. |
| 89 | |
| 90 | ## Chat |
| 91 | |
| 92 | Chat on the phone is the site's Chat: the same conversations, as they |
| 93 | happen. |
| 94 | |
| 95 | - **Conversations** show messages as the site draws them: bold, italic, |
| 96 | code, lists, quotes, tables and links, with `@mentions`, `#channels` |
| 97 | and `#123` references standing out. Messages by one person a few minutes |
| 98 | apart run together, and each day is marked. |
| 99 | - **Live.** New messages, edits, deletions and reactions appear as they |
| 100 | happen, and the line above the box says who is typing. Unread counts in |
| 101 | the list and on the **Chat** tab move as messages arrive anywhere. |
| 102 | - **Sending** shows your message at once. If it doesn't reach g1t, it |
| 103 | stays, marked **Not sent**: tap it to try again. |
| 104 | - **Long-press a message** to react, reply in a thread, copy it, or edit |
| 105 | or delete your own. Tap a reaction to add yours or take it back. |
| 106 | - **Threads** open from a message's replies, with the message they are |
| 107 | under at the top. |
| 108 | - **⋯** on a conversation stars, mutes or leaves it. |
| 109 | - **New message** (the pen at the top of Chat) messages a person, or a few |
| 110 | people together, or makes a channel. **Browse** at the |
| 111 | foot of the list joins public channels. |
| 112 | |
| 113 | A notification for a conversation you have open is not shown; one for |
| 114 | another shows as a banner at the top of the screen. |
| 115 | |
| 116 | ## Notifications |
| 117 | |
| 118 | The phone gets the same notifications as [browser push](/guides/notifications/#on-your-phone): |
| 119 | messages to you, mentions and replies in threads you are in, under the |
| 120 | same rules. Nothing comes while you are using |
| 121 | g1t in a browser or in the app itself, and nothing in |
| 122 | [Do not disturb](/guides/chat/#sounds-and-do-not-disturb). Tapping one |
| 123 | opens the conversation or thread it is about. |
| 124 | |
| 125 | The app asks to notify you the first time you sign in. To change it |
| 126 | later, use **More → Notifications on this phone**, or the phone's own |
| 127 | settings for g1t, where Android lists the **Messages** channel. Signing |
| 128 | out stops them on that phone. |
| 129 | |
| 130 | ## Signing in |
| 131 | |
| 132 | **Sign in with g1t** opens g1t.sh in your phone's browser, where you sign |
| 133 | in as usual (with your password, GitHub, two-factor) and approve the app. |
| 134 | The browser sends you back to the app, signed in. The app never sees your |
| 135 | password. This is [OAuth](/guides/authentication/#signing-in-with-oauth): |
| 136 | the app is listed as **g1t for Android** or **g1t for iOS** in |
| 137 | [Settings → Connected applications](https://g1t.sh/settings/applications), |
| 138 | where **Change access** narrows what it can do and **Sign out** ends it at |
| 139 | once. |
| 140 | |
| 141 | The approval page lists what the app asks for: reading your account, |
| 142 | workspaces, repositories, checks and workflows, reading and writing |
| 143 | work items, pull requests and notifications, and reading artifacts. Untick what you would rather it |
| 144 | could not do. |
| 145 | |
| 146 | **Use an access token** signs in with a |
| 147 | [personal access token](/guides/authentication/#access-tokens) you paste |
| 148 | in instead. The token stays on your phone, in its keystore. |
| 149 | |
| 150 | The app asks for `chat:read` and `chat:write` too. They let it use |
| 151 | Chat's routes and live connections on the site, and register for |
| 152 | notifications, and nothing else there: the app's sign-in cannot open the |
| 153 | site's pages as you. |
| 154 | |
| 155 | ## Links |
| 156 | |
| 157 | A `g1t://` link opens the app, as it opens [the desktop app](/guides/desktop/#links): |
| 158 | `g1t://acme/-/chat/dm/chn_1` is that conversation. The app shows the |
| 159 | pages it has screens for: |
| 160 | |
| 161 | | Link | Opens | |
| 162 | | --- | --- | |
| 163 | | `g1t://<workspace>/-/work`, with the list's filters (`?repo=web&label=bug`) | Work, filtered as the link says | |
| 164 | | `g1t://<workspace>/-/work/<number>` | The work item | |
| 165 | | `g1t://<workspace>/-/work/new` | A new work item | |
| 166 | | `g1t://<workspace>/-/chat`, `…/-/chat/<channel>`, `…/-/chat/dm/<id>` | Chat, or the conversation, in that workspace | |
| 167 | | `g1t://<owner>/<repo>` | The repository | |
| 168 | | `g1t://<owner>/<repo>/pull/<number>` | The pull request | |
| 169 | | `g1t://<owner>/<repo>/issues/<number>` | What that old issue number names in the repository: the work item the issue became, or a pull request. The app asks g1t, as the site does. `…/issues` and `…/issues/new` open Work filtered to the repository, and a new work item from it. | |
| 170 | |
| 171 | The same paths as `https://g1t.sh/…` links, such as |
| 172 | `https://g1t.sh/<workspace>/-/work/<number>`, open these screens once |
| 173 | g1t.sh publishes the files Android and iOS check first (see |
| 174 | [below](#whats-not-there-yet)). The workspace's labels and milestones open |
| 175 | on the site. |
| 176 | |
| 177 | Any other page opens on the site, in the browser. |
| 178 | |
| 179 | ## Your own g1t |
| 180 | |
| 181 | The app works with a g1t you [run yourself](/guides/self-hosting/) as well |
| 182 | as with g1t.sh. It talks to one g1t at a time, and opens on g1t.sh unless |
| 183 | you point it elsewhere. Two ways to point it at yours: |
| 184 | |
| 185 | - **Scan its code.** Your g1t's download page, `<your g1t>/download`, has |
| 186 | a QR code under its platforms, **Use the phone app with** your g1t. Scan it with the phone's camera, or |
| 187 | open the page on the phone and choose **Open in the g1t app**. The app |
| 188 | asks **Use g1t.example.com?**, then signs you in there. |
| 189 | - **Type its address.** On the sign-in screen, choose **Using your own |
| 190 | g1t? Sign in there** and enter the address you open it at in a browser, |
| 191 | such as `g1t.example.com`. |
| 192 | |
| 193 | Either way the app reads `<your g1t>/.well-known/g1t.json`, where your g1t |
| 194 | says where its API is, so you never type that. A g1t from before the phone |
| 195 | app has no such file: the app then takes the API to be `api.` in front of |
| 196 | the site, and offers **Its API is at another address** if it is not. |
| 197 | |
| 198 | The sign-in screen then says **Signing in to g1t.example.com**, with |
| 199 | **Change** and **Use g1t.sh**. Switching signs you out of the g1t you were |
| 200 | on. |
| 201 | |
| 202 | | Your g1t | What to know | |
| 203 | | --- | --- | |
| 204 | | Reached by the phone | `PUBLIC_URL` and `API_URL` must be addresses the phone can open. `localhost` on a phone is the phone itself: use your computer's address on the network, or a domain. | |
| 205 | | `https` | Store builds of the app open `https` addresses only, as Android requires. A development build also opens `http`, for a g1t on your own network. | |
| 206 | | Notifications | Work with no setup: your g1t sends them through Expo's push service, as g1t.sh does. To keep notifications' words off Expo's, Google's and Apple's services, set `PHONE_PUSH=off` ([self-hosting](/guides/self-hosting/#the-phone-app)); the app then says your g1t sends no notifications, and Chat still updates while it is open. | |
| 207 | | Older versions | A g1t from before the phone app does not let the app's sign-in into Chat. Upgrade it, or sign in with an access token that has **Use the website as you**. | |
| 208 | |
| 209 | ## What's not there yet |
| 210 | |
| 211 | - **Google Play and the App Store**, once Flagon's D-U-N-S number |
| 212 | arrives ([above](#install-it)). Until then, Android from the download |
| 213 | page; iOS waits for the App Store. |
| 214 | - **Home, Notifications and Artifacts** as tabs of their own. |
| 215 | Their pages open on the site meanwhile. |
| 216 | - **More of Work.** Changing an existing work item's labels, assignees |
| 217 | or milestone, reacting, and the workspace's **Labels** and |
| 218 | **Milestones** pages are on the site for now. |
| 219 | - **Attachments and custom emoji.** Files in messages, and a |
| 220 | workspace's own `:emoji:`, show as their names. |
| 221 | - **Replying from a notification**, without opening the app. |
| 222 | - **https links.** `g1t.sh` addresses open the site in the browser, not |
| 223 | the app, until g1t.sh publishes the files Android and iOS check first. |
| 224 | |
| 225 | ## For operators: building and releasing |
| 226 | |
| 227 | The app lives in `apps/mobile`: [Expo](https://expo.dev) with Expo |
| 228 | Router, in TypeScript, sharing types with the site through |
| 229 | `@g1t/contracts`. It builds with EAS Build. `apps/mobile/README.md` has |
| 230 | the commands for running it on a phone and the first-time setup. |
| 231 | |
| 232 | | Build | Command | What it makes | |
| 233 | | --- | --- | --- | |
| 234 | | Development | `eas build --profile development --platform android` | An APK of `g1t (dev)` (`sh.g1t.app.dev`) that loads its code from your computer. | |
| 235 | | Preview | `npm run build:android:apk -w @g1t/mobile` | An APK of `g1t` (`sh.g1t.app.preview`) to install on testers' phones. | |
| 236 | | Production | `npm run build:android -w @g1t/mobile` | An Android App Bundle of `g1t` (`sh.g1t.app`) for Google Play. | |
| 237 | |
| 238 | The three install side by side. `eas submit --platform android` sends |
| 239 | the latest production build to Google Play's internal testing track as a |
| 240 | draft, once there is a Play account to send it to. |
| 241 | |
| 242 | ### Releasing on g1t.sh/download |
| 243 | |
| 244 | Until the app is in Google Play, the `preview` build is the one people |
| 245 | install, from g1t.sh/download. A release is a tag `mobile-v<version>`, |
| 246 | where the version is `version` in `apps/mobile/app.config.ts`: push it, |
| 247 | and the `Mobile release` workflow (`.g1t/workflows/mobile-release.yml`) |
| 248 | has EAS build the APK, then publishes it to the `g1t-downloads` bucket |
| 249 | at `g1t.sh/downloads/mobile/<version>/` and points `mobile/latest.json` |
| 250 | at it, which the download page reads. `scripts/mobile-release.mjs` does |
| 251 | the same by hand (`build`, `fetch`, `manifest`, `publish`). |
| 252 | |
| 253 | | Secret or variable | What it is | |
| 254 | | --- | --- | |
| 255 | | `EXPO_TOKEN` | An Expo access token with access to the g1t project, from expo.dev | |
| 256 | | `CLOUDFLARE_API_TOKEN`, `CLOUDFLARE_ACCOUNT_ID` | As the deploy has them | |
| 257 | |
| 258 | Most changes need no release: `eas update --channel preview` in |
| 259 | `apps/mobile` sends the app's new code to every installed copy of that |
| 260 | version, which takes it the next time it opens. A release is for a change |
| 261 | to the app's native side (a new native module, `app.config.ts`) or its |
| 262 | `version`, which is also what decides which updates a copy takes. |