Go to file
Automated Release Test 642bb081ab Updates versions and adds release instructions to readme 2024-12-09 17:38:15 -05:00
.github fix(ci): garbage collect dev instances just on PR closure 2024-07-29 18:34:48 +01:00
docker
src
src-tauri Updates versions and adds release instructions to readme 2024-12-09 17:38:15 -05:00
.gitignore
README.md Updates versions and adds release instructions to readme 2024-12-09 17:38:15 -05:00
index.d.ts
index.html
package.json Updates versions and adds release instructions to readme 2024-12-09 17:38:15 -05:00
pnpm-lock.yaml
tsconfig.json
tsconfig.node.json
vite-env.d.ts
vite.config.ts

README.md

Zebra Launcher

A Desktop app for installing and running Zebra.

In-browser preview with example data

Installation

To install the Zebra Launcher:

  1. Download the installer for your operating system from the Github releases here.
  2. Run the installer

Note: It currently requires a 64-bit processor, and on macOS, an ARM-based processor such as the Apple M1.

Screenshots

 

Developer Setup

  1. Make sure all of the Tauri prerequisites are installed.
  2. Install pnpm
  3. Run pnpm i to install npm packages
  4. Run pnpm tauri dev to start the Tauri app.
  5. Add an empty dist folder to the root of this project to fix the Rust warning in src-tauri/src/main.rs
  6. Install Prettier for formatting .ts/.tsx/.css files

Release

  • Update zebrad binaries for target platforms by:
    • Running cargo b --release in the Zebra workspace
    • Copying the binary into src-tauri/binaries and adding the target as a suffix to the file name
  • Tag and publish a new release on Github
  • Run pnpm run tauri build on target platforms, and
  • Upload the bundle files produced by Tauri as assets on the Github release.