gui/README.md
2022-12-14 06:53:30 +08:00

36 lines
No EOL
849 B
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
```
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)