mirror of
https://github.com/ivabus/gui
synced 2025-04-23 14:07:14 +03:00
Clean up readmes, remove broken instructions (#535)
This commit is contained in:
Max Howell
GitHub
parent
9f2c698cf1
commit
80d926cd71
3 changed files with 34 additions and 128 deletions
71
README.md
71
README.md
|
|
@ -7,17 +7,38 @@
|
|||
<a href="https://discord.gg/JKzuqrW9">
|
||||
<img src="https://img.shields.io/discord/906608167901876256?label=discord&color=29f746" alt="Discord" />
|
||||
</a>
|
||||
<a href="#">
|
||||
<img src="https://img.shields.io/github/v/release/teaxyz/cli?label=tea/cli&color=ff00ff" alt="Version" />
|
||||
<a href="https://docs.tea.xyz">
|
||||
<img src="https://img.shields.io/badge/-docs-2675f5?logoColor=fff&color=ff00ff&logo=gitbook" alt="Documentation & Manual" />
|
||||
</a>
|
||||
</p>
|
||||
|
||||
The Open Store.
|
||||
|
||||
tea/gui is the graphical app complement to [`tea/cli`].
|
||||
|
||||
Under the hood tea/gui installs and manages your packages with [`tea/cli`]
|
||||
while exposing additional functionality, features and informational touches
|
||||
that complement and expand upon what a package manager can do.
|
||||
|
||||
To install the gui, visit: https://tea.xyz/gui/ and download the latest
|
||||
version. The gui auto-updates itself.
|
||||
|
||||
|
||||
|
||||
|
||||
# Developing `tea/gui`
|
||||
# Contributing to `tea/gui`
|
||||
|
||||
To develop within an Electron view:
|
||||
tea/gui is a Svelte Electon app. The electron “backend” can be found in
|
||||
`modules/desktop`, the Svelte “frontend” in `modules/ui`. In addition the
|
||||
following technologies are used:
|
||||
|
||||
- [svelte](https://svelte.dev/)
|
||||
- [tailwind](https://tailwindcss.com/)
|
||||
- [fontastic](https://fontastic.me) (an icon font)
|
||||
|
||||
If you have suggestions or ideas, start a [discussion]. If we agree, we’ll
|
||||
move it to an issue. Bug fixes straight to pull request or issue please!
|
||||
|
||||
# Hacking on `tea/gui`
|
||||
|
||||
```sh
|
||||
xc setup # only required once
|
||||
|
|
@ -25,41 +46,14 @@ xc build # only required if you modify the backend
|
|||
xc dev # opens the app in dev mode
|
||||
```
|
||||
|
||||
Creating a locally built installer for local usage will not need code-signing
|
||||
and notarization. To skip the 2-steps:
|
||||
|
||||
```sh
|
||||
$ export CSC_IDENTITY_AUTO_DISCOVERY=false
|
||||
$ xc dist
|
||||
```
|
||||
|
||||
# Contributing to `tea/gui`
|
||||
If you have suggestions or ideas, start a [discussion]. If we agree, we’ll move it to an issue. Bug fixes straight to pull request or issue please!
|
||||
|
||||
|
||||
# Releasing `tea/gui`
|
||||
|
||||
Tag any commit in the main branch, then push directly to the main branch.
|
||||
Lets follow the [semver] versioning standard, prefixed with `v`:
|
||||
|
||||
```sh
|
||||
$ git tag v1.0.0
|
||||
$ git push origin tag v1.0.0
|
||||
```
|
||||
|
||||
Refer to each package `README.md` for instructions on how to setup and
|
||||
contribute to them:
|
||||
|
||||
* [tea/desktop](./modules/desktop/README.md)
|
||||
* [tea/ui](./modules/ui/README.md)
|
||||
> Make sure to run `xc prettier` before submitting pull-requests.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
# Tasks
|
||||
|
||||
The following can be run with [`xc`], eg. `xc build`
|
||||
The following can be run with [`xc`], eg. `xc build`.
|
||||
|
||||
## Setup
|
||||
|
||||
|
|
@ -114,8 +108,13 @@ pnpm run -r check
|
|||
pnpm run -r lint
|
||||
```
|
||||
|
||||
|
||||
|
||||
|
||||
# Dependencies
|
||||
|
||||
[`tea/cli`] will automagically make these available to your environment.
|
||||
|
||||
| Project | Version |
|
||||
|-----------------------------------|-----------|
|
||||
| nodejs.org | =18.15.0 |
|
||||
|
|
@ -123,8 +122,6 @@ pnpm run -r lint
|
|||
| xcfile.dev | >=0.0.110 |
|
||||
| python.org | >=3.10 |
|
||||
|
||||
[aws/cli]: https://aws.amazon.com/cli/
|
||||
[`tea/cli`]: https://github.com/teaxyz/cli
|
||||
[`xc`]: https://xcfile.dev
|
||||
[semver]: https://semver.org
|
||||
[notion]: https://www.notion.so/teaxyz/tea-gui-fdd9f50aa980432fa370b2cf6a03cb50
|
||||
[discussion]: https://github.com/orgs/teaxyz/discussions
|
||||
|
|
|
|||
|
|
@ -1,61 +0,0 @@
|
|||
# @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
|
||||
|
||||
|
||||
|
||||
## 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
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
# @tea/ui
|
||||
|
||||
Isolated set of UI elements/components that can be reused across all svelte related apps of tea. Components here have to be maintained as much as possible as a [dumb/presentational components](https://medium.com/@thejasonfile/dumb-components-and-smart-components-e7b33a698d43).
|
||||
|
||||
## Developing
|
||||
|
||||
```bash
|
||||
$ pnpm install # assuming you have not done so
|
||||
|
||||
# this will open your browser and show a library of UI elements
|
||||
$ pnpm dev
|
||||
```
|
||||
|
||||
### How to update icons
|
||||
|
||||
1. update fontastic.me tea-icons, you would probably need tom's credentials
|
||||
2. run `pnpm update-icons`
|
||||
3. stage and commit the changes
|
||||
|
||||
## Todo
|
||||
|
||||
[] setup a scaffolding script to make it easier making elements
|
||||
|
||||
## Design System
|
||||
|
||||
This library is dependent on the following
|
||||
|
||||
- [svelte](https://svelte.dev/)
|
||||
- [tailwind](https://tailwindcss.com/)
|
||||
- [fontastic](https://fontastic.me)
|
||||
Loading…
Reference in a new issue