Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 3 additions & 4 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -57,16 +57,15 @@ jobs:
uses: actions/cache@v4
with:
path: node_modules/
key: node_modules-${{ runner.os }}-${{ hashFiles('yarn.lock') }}
key: node_modules-${{ runner.os }}-${{ hashFiles('package-lock.json') }}

- name: Install node.js
uses: actions/setup-node@v5
with:
node-version-file: '.nvmrc'

- run: npm install yarn -g
- run: yarn install
- run: yarn build
- run: npm ci
- run: npm run build

- name: Generate Capacitor Config
run: node capacitor.config.generator.mjs
Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/tauri-nightly.yml
Original file line number Diff line number Diff line change
Expand Up @@ -252,9 +252,8 @@ jobs:
with:
node-version-file: .nvmrc

- run: npm install yarn -g
- run: yarn install
- run: yarn build
- run: npm ci
- run: npm run build
- run: node capacitor.config.generator.mjs
- run: npx cap sync android

Expand Down
5 changes: 2 additions & 3 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,8 @@ jobs:
uses: actions/setup-node@v5
with:
node-version-file: '.nvmrc'
cache: yarn
cache: npm

- run: npm install yarn -g
- run: yarn install --frozen-lockfile
- run: npm ci
- run: npm run lint
- run: npm run test
2 changes: 0 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@

node_modules/
npm-debug.log*
yarn-debug.log*
yarn-error.log*

# App Build process
cache/
Expand Down
33 changes: 16 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,61 +110,60 @@ If you prefer to have the application in English or any other language, you can

### Technical details

The next versions of the App will be a modern tool that based on PWA (Progressive Web Application) and uses principally Node, Yarn, Vite and Vue for development and building. For Android we use Capacitor as wrapper over the PWA. To build and develop over it, follow the instructions below.
The next versions of the App will be a modern tool that based on PWA (Progressive Web Application) and uses principally Node, npm, Vite and Vue for development and building. For Android we use Capacitor as wrapper over the PWA. To build and develop over it, follow the instructions below.

### Prepare your environment

1. Install [node.js](https://nodejs.org/) (refer to [.nvmrc](./.nvmrc) for minimum required version)
2. Install yarn: `npm install yarn -g`

### PWA version

#### Run development version

1. Change to project folder and run `yarn install`.
2. Run `yarn dev`.
1. Change to project folder and run `npm install`.
2. Run `npm run dev`.
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to note "Press q to quit."?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redacting.

  ➜  press h + enter to show help
h

  Shortcuts
  press r + enter to restart the server
  press u + enter to show server url
  press o + enter to open in browser
  press c + enter to clear console
  press q + enter to quit

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not mentioned in betaflight.com README.md either


The web app will be available at http://localhost:8000 with full HMR.
The web app will be available at http://localhost:8080 with full HMR.

#### Run production version

1. Change to project folder and run `yarn install`.
2. Run `yarn build`.
3. Run `yarn preview` after build has finished.
1. Change to project folder and run `npm install`.
2. Run `npm run build`.
3. Run `npm run preview` after build has finished.

Alternatively you can run `yarn review` to build and preview in one step.
Alternatively you can run `npm run review` to build and preview in one step.

The web app should behave directly as in production, available at http://localhost:8080.

### Android version

NOTE: The Android version is not fully functional yet. It is in development.
The Android version uses Capacitor as the native wrapper with custom plugins to bridge the PWA to native capabilities.

#### Prerequisites

You need to install [Android Studio](https://developer.android.com/studio) as Capacitor apps are configured and managed through it.

#### Run development version

1. Change to project folder and run `yarn install`.
2. Run `yarn android:run`.
1. Change to project folder and run `npm install`.
2. Run `npm run android:run`.

The command will ask for the device to run the app. You need to have some Android virtual machine created or some Android phone [connected using ADB](https://developer.android.com/tools/adb).

As alternative to the step 2, you can execute a `yarn android:open` to open de project into Android Studio and run or debug the app from there.
As alternative to the step 2, you can execute a `npm run android:open` to open de project into Android Studio and run or debug the app from there.

#### Run development version with live reload

1. Change to project folder and run `yarn install`.
2. Run `yarn dev --host`. It will start the vite server and will show you the IP address where the server is listening.
3. Run `yarn android:dev`
1. Change to project folder and run `npm install`.
2. Run `npm run dev -- --host`. It will start the vite server and will show you the IP address where the server is listening.
3. Run `npm run android:dev`

This will ask for the IP where the server is running (if there are more than one network interfaces). You need to have some Android virtual machine created or some Android phone [connected using ADB](https://developer.android.com/tools/adb).
Any change make in the code will reload the app in the Android device.

### Running tests

`yarn test`
`npm test`

## Support and Developers Channel

Expand Down
109 changes: 57 additions & 52 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

10 changes: 2 additions & 8 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
"@rollup/plugin-node-resolve": "^16.0.0",
"@rollup/plugin-replace": "^6.0.2",
"@storybook/addon-actions": "^8.6.3",
"@storybook/addon-essentials": "^8.6.3",
"@storybook/addon-essentials": "^8.6.14",
"@storybook/addon-links": "^8.6.3",
"@storybook/vue3": "^8.6.3",
"@tauri-apps/cli": "~2.10.0",
Expand All @@ -111,12 +111,6 @@
"run-script-os": "^1.1.6",
"vite": "^7.3.2",
"vite-plugin-mkcert": "^1.17.9",
"vitest": "^3.2.4",
"yarn": "^1.22.22"
},
"resolutions": {
"string-width": "4.2.3",
"strip-ansi": "6.0.1",
"wrap-ansi": "7.0.0"
"vitest": "^3.2.4"
}
}
Loading
Loading