sanctum/README.md

Avia Client for Desktop "stoat desktop"

Application for Windows, macOS, and Linux. now with avia client injected

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/AvaLilac/for-desktop/tree/dev aviaclient-for-desktop
cd aviaclient-for-desktop

# install all packages
pnpm i --frozen-lockfile

# update the assets. if you are using stoat's
git -c submodule."assets".update=checkout submodule update --init assets

# build the bundle
pnpm package

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