Downloads for Windows, Linux and Android: sloga.gg
A fork of the upstream Revolt/Stoat web client, AGPL-licensed.
Before contributing, read the code style guidelines.
Before getting started, you'll want to install:
Then proceed to setup:
# clone the repository
git clone --recursive https://github.com/sloga-mcp/sloga-frontend client
cd client
# update submodules if you pull new changes
# git submodule init && git submodule update
# install all packages
mise install:frozen
# build deps:
mise build:deps
# or build a specific dep (e.g. stoat.js updates):
# pnpm --filter stoat.js run build
# customise the .env
cp packages/client/.env.example packages/client/.env
# run dev server
mise dev
# run all CI checks locally
mise checkFinally, navigate to http://localhost:5173.
By default, the client connects to a backend running on the same host (localhost).
If you want the client to connect to the official hosted backend instead, open the .env file at /packages/client/.env and comment out the local URL varaibles like this:
# connect to a local Sloga instance
#VITE_API_URL=http://localhost:14702
#VITE_WS_URL=ws://localhost:14703
#VITE_MEDIA_URL=http://localhost:14704
#VITE_PROXY_URL=http://localhost:14705
When these variables are not set, the client automatically falls back to the official backend. (See env.ts.)
# install packages
mise install:frozen
# build dependencies
mise build:deps
# build for web
mise build
# ... when building for Sloga production
mise build:prodYou can now deploy the directory packages/client/dist.
The app currently needs the following routes:
/login/pwa/dev/discover/settings/invite/bot/friends/server/channel
This corresponds to Content.tsx#L33.