8fd6f35729
|
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| assets@628eb2f825 | ||
| src | ||
| .eslintrc.json | ||
| .gitignore | ||
| .gitmodules | ||
| .prettierrc | ||
| LICENSE | ||
| README.md | ||
| default.nix | ||
| forge.config.ts | ||
| forge.env.d.ts | ||
| index.html | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| strings.ts | ||
| tsconfig.json | ||
| vite.main.config.ts | ||
| vite.preload.config.ts | ||
| vite.renderer.config.ts | ||
README.md
Stoat for Desktop
Development Guide
Contribution guidelines for Desktop app TBA!
Before getting started, you'll want to install:
- Git
- Node.js
- pnpm (run
corepack enable)
Then proceed to setup:
# clone the repository
git clone --recursive https://github.com/stoatchat/for-desktop stoat-for-desktop
cd stoat-for-desktop
# install all packages
pnpm i --frozen-lockfile
# start the application
pnpm start
# ... or build the bundle
pnpm package
# ... or build all distributables
pnpm make
Pulling in Stoat's assets
If you want to pull in Stoat brand assets after pulling, run the following:
# update the assets
git -c submodule."assets".update=checkout submodule update --init assets
Currently, this is required to build, any forks are expected to provide their own assets.
Publishing Guide
To publish a new version, simply tag a new release by:
- Edit
package.jsonwith the new version - Create a new tag from latest commit by
git tag v1.0.0 - Push the tag and commit by
git push --atomic origin main v1.0.0