gui/modules/desktop/README.md
Neil a7a63ad030
Crowdin dynamic update (#268)
* #264 i18n dropdown ui

* #264 improve i18n configuration to use hardcoded english as default

* #264 sync language english to crowdin when merged to main

---------

Co-authored-by: neil <neil@neils-MacBook-Pro.local>
2023-03-07 11:12:11 +08:00

61 lines
2 KiB
Markdown

# @tea/desktop
Desktop app of [tea](https://tea.xyz) for installing packages/softwares
More interesting and possibly updated documentations are at this [NOTION](https://www.notion.so/teaxyz/tea-gui-fdd9f50aa980432fa370b2cf6a03cb50) page. It is ideal to review it also, its more updated.
## Developing
Once you've created a project and installed dependencies with `npm install` (or `pnpm install` or `yarn`), start a development server:
```bash
# use if you need interaction with the rust handlers
pnpm dev
```
## Building
To create a production version of your app:
```bash
pnpm run build
```
You can preview the production build with `npm run preview`.
> To deploy your app, you may need to install an [adapter](https://kit.svelte.dev/docs/adapters) for your target environment.
## Testing
```bash
pnpm playwright install
pnpm test
```
## i18n
Default locale is `english` it is defined in `src/libs/translations/translations.json`. Include all new keys there then this will automatically sync to crowdin once merged to `main`.
Data from [crowdin](https://crowdin.com) our translation app/community will only be loaded when env var `SYNC_I18N` exists. Currently only configured on top of the GHA CI/CD workflows.
## Intuition Building Links
<p align="center">
<img src="https://github.com/Dax89/electron-sveltekit/blob/master/icon.png" width="256">
</p>
<p align="center">
A minimal project template for Electron and SvelteKit configured with <a href="https://www.npmjs.com/package/@sveltejs/adapter-static">adapter-static</a>.
</p>
## Screenshot
![Screenshot](https://github.com/Dax89/electron-sveltekit/blob/master/screenshot.png)
## Commands
- `pnpm dev`: Runs SvelteKit in dev mode
- `pnpm preview`: Runs SvelteKit in production mode
- `pnpm electron`: Runs SvelteKit with electron in dev mode
- `pnpm build`: Runs SvelteKit compiler
- `pnpm dev:package`: Creates an Electron package (you can inspect the contents)
- `pnpm package`: Creates a distributable Electron package