|
| 1 | +[](https://github.com/zenoxs/tauri-appcenter-companion/actions/workflows/publish.yml) |
| 2 | +[](https://github.com/zenoxs/tauri-appcenter-companion/releases/latest) |
| 3 | +[](https://github.com/zenoxs/tauri-appcenter-companion/releases/latest) |
| 4 | +[](https://github.com/zenoxs/tauri-appcenter-companion/blob/main/LICENSE) |
| 5 | + |
1 | 6 | # Tauri AppCenter Companion |
2 | 7 |
|
3 | | -A companion app written with **React** aand **Tauri** to help manage your applications on appcenter. |
| 8 | +A companion app written with **React** and **Tauri** to help manage your applications on appcenter. This idea is to provide an easy way to group your appcenter's applications into a single view, that way you can easily build all your related application with one click and follow the progress and status. |
4 | 9 |
|
5 | 10 |  |
6 | 11 |  |
7 | 12 |
|
8 | | -## Install |
| 13 | +## Features |
| 14 | + |
| 15 | +- Consult the build status (in live) of all your applications |
| 16 | +- Start / Cancel the build of your app |
| 17 | +- Start / Cancel the build of all your apps in bundled application |
| 18 | + |
| 19 | +## How to use it ? |
| 20 | + |
| 21 | +### Add token api |
| 22 | + |
| 23 | +First install the application from the [release page](https://github.com/zenoxs/tauri-appcenter-companion/releases/latest): |
| 24 | + |
| 25 | +- **AC.Companion_x.x.x_x64.dmg** for intel MacOS |
| 26 | +- **AC.Companion_x.x.x_x64_en-US.msi** for Windows |
| 27 | +- **ac-companion_x.x.x_amd64.AppImage** for Linux |
| 28 | +- **ac-companion_x.x.x_amd64.deb** for Debian\* system |
| 29 | + |
| 30 | +First you need to create an API Token from your Appcenter account. This can be done in 2 ways: |
| 31 | + |
| 32 | +- From your Appcenter [account settings](https://appcenter.ms/settings/apitokens), **/!\\ remark** if you do so thee generated token will have access to all your apps. |
| 33 | +- From the settings of your app : https://appcenter.ms/orgs/{owner}/apps/{app-name}/settings/apitokens |
| 34 | + |
| 35 | + |
| 36 | + |
| 37 | +Then copy the generated token, open the "API Tokens" settings from the app and add a new token. |
| 38 | + |
| 39 | +### Create a bundled application |
| 40 | + |
| 41 | +_What is a bundled application ?_ |
| 42 | +A bundled application is a logical representation of multiple appcenter's applications. If you relate on a single base code framework and you want to build, for example, your Android and iOS application you need to go each time to the detail of th application to launch and track the build. With a bundled application you can manage all your applications's build in a single view. |
| 43 | + |
| 44 | +**To create a bundled application** you need to navigate to the **Applications** page and click on the **Add** button. Then the app will fetch all your registered token-based apps with their configured branches. You can select which branches will compose your bundled application and the name of your bundled application. Then press the **Save** button to create your bundled application and voilà. |
| 45 | + |
| 46 | +## Confidentiality & Security |
| 47 | + |
| 48 | +## |
| 49 | + |
| 50 | +**Q:** Do AC Companion can acccess to my appcenter's account? |
| 51 | + |
| 52 | +**A:** No, the application is designed to be a serverless app. All your data is stored in your local machine. AC Companion only use the [App Center API](https://openapi.appcenter.ms/) to communicate with your appcenter's account. |
| 53 | + |
| 54 | +## |
| 55 | + |
| 56 | +--- |
| 57 | + |
| 58 | +## Development |
| 59 | + |
| 60 | +### Install |
9 | 61 |
|
10 | 62 | ```shell |
11 | 63 | yarn install |
12 | 64 | ``` |
13 | 65 |
|
14 | | -## Start app in dev |
| 66 | +### Start app in dev |
15 | 67 |
|
16 | 68 | ```shell |
17 | 69 | yarn run tauri dev |
18 | 70 | ``` |
19 | | - |
20 | | -## Getting Started |
21 | | - |
22 | | -TODO |
|
0 commit comments