mirror of
https://github.com/ivabus/gui
synced 2025-04-24 14:37:11 +03:00
50 lines
No EOL
1.3 KiB
Markdown
50 lines
No EOL
1.3 KiB
Markdown
# Tea UI Workspace
|
|
This repository includes the tea GUI/Desktop App.
|
|
|
|
For better documentation checkout this [notion](https://www.notion.so/teaxyz/tea-gui-fdd9f50aa980432fa370b2cf6a03cb50).
|
|
|
|
# Requirements
|
|
* [pnpm@^7.8](https://pnpm.io/)
|
|
* [node@^16](https://github.com/tj/n)
|
|
* [rust@^1.62](https://www.rust-lang.org/)
|
|
* [cargo@^1.62](https://crates.io/)
|
|
|
|
# Development
|
|
Setting up the workspace just run here:
|
|
```
|
|
$ pnpm install
|
|
```
|
|
|
|
To develop the GUI within Tauri Webview
|
|
```
|
|
$ pnpm dev:gui
|
|
```
|
|
|
|
To develop the GUI within your local browser at localhost:8080
|
|
```
|
|
$ pnpm web:gui
|
|
```
|
|
# Build a GUI installer
|
|
This assumes you have installed the dev dependencies
|
|
```
|
|
$ pnpm build:gui
|
|
```
|
|
|
|
# Creating a release
|
|
Tag any commit in the main branch, then push directly to the main branch.
|
|
Lets follow the [semver](https://semver.org/) versioning standard, prefixed with `v`: ie `v1.2.3`
|
|
```
|
|
$ git tag v1.0.0
|
|
$ git push <remote> tag v1.0.0
|
|
```
|
|
We do not have a runner for building for M1 and M2, to manually deploy a release. Make sure you have a [aws-cli](https://aws.amazon.com/cli/). Configure your aws cli profile correctly.
|
|
To publish a release simply run
|
|
```
|
|
$ AWS_PROFILE=tea/or/etc pnpm release
|
|
```
|
|
|
|
|
|
Refer to each package README.md for instructions on how to setup and contribue to them:
|
|
|
|
* [tea/gui](./packages/gui/README.md)
|
|
* [tea/ui](./packages/ui/README.md) |