Skip to content

README.md

Latest commit

 

History

History
84 lines (63 loc) · 2.95 KB

README.md

File metadata and controls

84 lines (63 loc) · 2.95 KB

Stoat for Desktop

Stars Forks Pull Requests Issues Contributors License

Application for Windows, macOS, and Linux.

Installation

Packaging status
  • 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.