βΌοΈ READ: THIS IS STILL IN DEVELOPMENT
This is still in early development. Everything you see here may - and likely will - be tweaked or changed further before release.
Revolt Frontend
This repository contains the code for Revolt's new frontend, built with Solid.js.
You can find the code style guidelines here.
Setup locally
# clone the repository
git clone --recursive https://github.com/revoltchat/frontend client
cd client
# update submodules if you pull new changes
# git submodule init && git submodule update
# install all packages
pnpm i
# build deps:
pnpm build:deps
# or build a specific dep (e.g. revolt.js updates):
# pnpm --filter revolt.js run build
# run dev server
pnpm dev
Finally, navigate to http://local.revolt.chat:5173.
Build client
# install packages
pnpm i
# build everything
pnpm build:all
Pulling in Revolt's assets
If you want to pull in Revolt brand assets after pulling, run the following:
# update the assets
git -c submodule."packages/client/assets".update=checkout submodule update --init packages/client/assets
You can switch back to the fallback assets by running deinit and continuing as normal:
# deinit submodule which clears directory
git submodule deinit packages/client/assets
Faster iteration with Revolt.js
To make it easier to work with revolt.js
, you may want to temporarily make this change:
# packages/revolt.js/package.json
- "module": "lib/esm/index.js",
+ "module": "src/index.ts",
Any edits to the revolt.js codebase will immediately be reflected while developing.
pnpm
Using Add a new package to a workspace:
pnpm add solid-hcaptcha --filter @revolt/auth
Deployment Information
The app currently needs the following routes:
/server
/channel
/friends
/admin
/app
/pwa