see here for the list of software required to build / develope the app.
Then, make sure to install app dependencies:
$ pnpm install
Now you should be able to run the app in development mode:
$ pnpm tauri dev
By default it will not print debug logs to console. If you want debug logs, use debug
feature:
$ pnpm tauri dev --features debug
Stories is our easy way to view our app components. Running the following command will launch in your default browser.
$ pnpm story:dev
Javascript:
$ pnpm lint
$ pnpm format
Rust:
$ cargo clippy # see linting errors
$ cargo fmt # format code
App writes logs into:
- stdout in development mode
- Logs directory
We are also collecting tokio's runtime tracing information that could be viewed using tokio-console:
- developlent:
$ tokio-console
- nightly:
$ tokio-console http://127.0.0.1:6668
- production:
$ tokio-console http://127.0.0.1:6667
To build the app in production mode, run:
$ pnpm tauri build --features devtools --config packages/tauri/tauri.conf.nightly.json
This will make an asset similar to our nightly build.
$ pnpm tauri icon path/to/icon.png
Building is done via GitHub Action.
Go to the link and select Run workflow
from the desired branch.
When running the release action,
you will have to choose one of major
, minor
, or patch
release type. Action will generate a new version based on your input and current
version found at https://app.gitbutler.com/releases
.
To publish a version that you've just build, use Release Manager.