Developing `tea/gui`

To develop within an Electron view:

xc setup  # only required once
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 codesigning and notarization, to skip the 2-steps:

$ 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:

$ 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:

Tasks

The following can be run with xc, eg. xc build

Setup

Setup ensures that required configuration placeholder files are present and installs dependencies.

if [ ! -e modules/desktop/electron/config.json ]; then
  echo '{}' > modules/desktop/electron/config.json
fi

if [ ! -e modules/desktop/.env ]; then
  cp modules/desktop/.env.example modules/desktop/.env
fi
pnpm install
pnpm run -r prepare

Build

pnpm install
pnpm build:desktop

Dev

pnpm install
pnpm dev

Prettier

pnpm run -r format

Dist

pnpm install
pnpm --filter tea exec pnpm predist
pnpm --filter tea exec pnpm dist

Check

Runs the typescript compiler and linter.

pnpm run -r check
pnpm run -r lint

Dependencies

Project	Version
nodejs.org	=18.15.0
pnpm.io	=7.18.2
xcfile.dev	>=0.0.110
python.org	>=3.10

2.8 KiB Raw Blame History Unescape Escape

Developing tea/gui

Contributing to tea/gui

Releasing tea/gui