sfalken
1243f88b21
* Add files for flathub compliance Please see: https://github.com/flathub/flathub/pull/7783 This adds the requested files to the upstream git repo, and adds the screenshot.png so it may be sourced from Stoat, rather than from a user repository. * chore: update product screenshot * chore: update desktop entry comment * chore: update icon * chore: update summary to current github tag --------- Co-authored-by: Shawn W Dunn <sfalken@opensuse.org> Co-authored-by: izzy <me@insrt.uk>
Stoat for Desktop
Installation
- All downloads and instructions for Stoat can be found on our Website.
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
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.