zebra-launcher/README.md

# Zebra Launcher

A Desktop app for installing and running Zebra.

[In-browser preview with example data](https://zebra-app-v0-zi2rzymvea-ue.a.run.app/)

## Installation

To install the Zebra Launcher:

1. Download the installer for your operating system from the Github releases [here](https://github.com/ZcashFoundation/zebra-app/releases/tag/v0.0.0-alpha.1).
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

<img src="https://github.com/ZcashFoundation/zebra-app/assets/5491350/4fb8b310-15e7-47be-8650-18a24b733ebc" width="400">
&nbsp;
<img src="https://github.com/ZcashFoundation/zebra-app/assets/5491350/564bef27-5b82-4f1e-8e9f-af709bf48528" width="400">

## Developer Setup

1. Make sure all of the [Tauri prerequisites](https://beta.tauri.app/guides/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

#### Recommended IDE Setup

- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)
Update README.md 2024-03-21 11:14:07 -07:00			`# Zebra Launcher`
init 2024-02-27 18:05:37 -08:00
Update README.md 2024-03-11 14:44:50 -07:00			`A Desktop app for installing and running Zebra.`
init 2024-02-27 18:05:37 -08:00
Update README.md to include a link to the latest in-browser preview deployment 2024-03-12 20:02:31 -07:00			`[In-browser preview with example data](https://zebra-app-v0-zi2rzymvea-ue.a.run.app/)`

Update README.md with screenshots and installation instructions 2024-03-12 19:54:56 -07:00			`## Installation`
init 2024-02-27 18:05:37 -08:00
Update README.md 2024-03-21 11:14:07 -07:00			`To install the Zebra Launcher:`
Update README.md with screenshots and installation instructions 2024-03-12 19:54:56 -07:00
			`1. Download the installer for your operating system from the Github releases [here](https://github.com/ZcashFoundation/zebra-app/releases/tag/v0.0.0-alpha.1).`
			`2. Run the installer`

Update README.md to mention that there are currently only installers for 64-bit processor 2024-03-12 20:00:25 -07:00			`Note: It currently requires a 64-bit processor, and on macOS, an ARM-based processor such as the Apple M1.`
Update README.md with screenshots and installation instructions 2024-03-12 19:54:56 -07:00
			`## Screenshots`
Use Tauri v2-beta and SolidJS (#1) * cargo create-tauri-app --beta * adds generated files from yarn && yarn tauri dev, adds public dir resolve alias * fixes a ts warning that an svg file can't be found * starts zebrad process and emits its logs as events * works * Adds setup instructions * removes extensions.json * adds styled-components and styles --------- Co-authored-by: Automated Release Test <release-tests-no-reply@zfnd.org> 2024-02-28 17:31:59 -08:00
Update README.md to resize screenshots 2024-03-12 19:56:38 -07:00			`<img src="https://github.com/ZcashFoundation/zebra-app/assets/5491350/4fb8b310-15e7-47be-8650-18a24b733ebc" width="400">`
Update README.md with screenshots and installation instructions 2024-03-12 19:54:56 -07:00			` `
Update README.md to resize screenshots 2024-03-12 19:56:38 -07:00			`<img src="https://github.com/ZcashFoundation/zebra-app/assets/5491350/564bef27-5b82-4f1e-8e9f-af709bf48528" width="400">`
Update README.md with screenshots and installation instructions 2024-03-12 19:54:56 -07:00
			`## Developer Setup`
Use Tauri v2-beta and SolidJS (#1) * cargo create-tauri-app --beta * adds generated files from yarn && yarn tauri dev, adds public dir resolve alias * fixes a ts warning that an svg file can't be found * starts zebrad process and emits its logs as events * works * Adds setup instructions * removes extensions.json * adds styled-components and styles --------- Co-authored-by: Automated Release Test <release-tests-no-reply@zfnd.org> 2024-02-28 17:31:59 -08:00
			`1. Make sure all of the [Tauri prerequisites](https://beta.tauri.app/guides/prerequisites/) are installed.`
Update README.md 2024-03-05 18:32:42 -08:00			2. Install `pnpm`
			3. Run `pnpm i` to install npm packages
			4. Run `pnpm tauri dev` to start the Tauri app.
Use Tauri v2-beta and SolidJS (#1) * cargo create-tauri-app --beta * adds generated files from yarn && yarn tauri dev, adds public dir resolve alias * fixes a ts warning that an svg file can't be found * starts zebrad process and emits its logs as events * works * Adds setup instructions * removes extensions.json * adds styled-components and styles --------- Co-authored-by: Automated Release Test <release-tests-no-reply@zfnd.org> 2024-02-28 17:31:59 -08:00			5. Add an empty `dist` folder to the root of this project to fix the Rust warning in `src-tauri/src/main.rs`
Update README.md with screenshots and installation instructions 2024-03-12 19:54:56 -07:00			6. Install `Prettier` for formatting .ts/.tsx/.css files

			`#### Recommended IDE Setup`

			`- [VS Code](https://code.visualstudio.com/) + [Tauri](https://marketplace.visualstudio.com/items?itemName=tauri-apps.tauri-vscode) + [rust-analyzer](https://marketplace.visualstudio.com/items?itemName=rust-lang.rust-analyzer)`