ddb0996cf0
|
||
|---|---|---|
| .github/workflows | ||
| .vscode | ||
| assets@f106946659 | ||
| src | ||
| .eslintrc.json | ||
| .gitignore | ||
| .gitmodules | ||
| .prettierrc | ||
| LICENSE | ||
| README.md | ||
| default.nix | ||
| forge.config.ts | ||
| forge.env.d.ts | ||
| index.html | ||
| package-lock.json | ||
| 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 (CTFAM)
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/mattmckenzy/for-desktop stoat-for-desktop-ctfam
cd stoat-for-desktop-ctfam
# install all packages
pnpm i --frozen-lockfile
# start the application
pnpm start
# ... or build the bundle
pnpm package
# ... or build all distributables
pnpm make
Various useful commands for development testing:
# connect to the development server
pnpm start -- --force-server http://localhost:5173
# test the flatpak (after `make`)
pnpm install:flatpak
pnpm run:flatpak
# ... also connect to dev server like so:
pnpm run:flatpak --force-server http://localhost:5173
# Nix-specific instructions for testing
pnpm package
pnpm run:nix
# ... as before:
pnpm run:nix --force-server=http://localhost:5173
# a better solution would be telling
# Electron Forge where system Electron is
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.
Changes for original source (stoatchat)
The only changes made are those to point to my instance of stoatchat on ctfam.ca