This is the web client for Revolt, which is also available live at https://app.revolt.chat.
135dbe2da4
The GitHub action `actions/cache@v2` is no longer available. Last successful docker build was 2024-11-15 I've removed the caching, as merely upgrading the version of the cache script did not fix the problem. Since the revoltchat/revite is deprecated I believe that the lack of caching in builds shouldn't be an undue burden on GitHub. Only 9 commits have been made here since builds stopped working The logic for publishing Docker containers has been shuffled so that the build is executed only once when publishing. I have tested building to GitHub's container registry, but not to dockerhub, I do not forsee any issues there. Main reason for doing this, is that a fix for attachment downloads (https://github.com/revoltchat/revite/pull/1067) is not easily available to anyone running self-hosted. |
||
|---|---|---|
| .github | ||
| .vscode | ||
| .yarn | ||
| external | ||
| public | ||
| scripts | ||
| src | ||
| .babelrc | ||
| .dockerignore | ||
| .env | ||
| .env.build | ||
| .gitignore | ||
| .gitmodules | ||
| .prettierignore | ||
| .prettierrc.js | ||
| .yarnrc.yml | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| disabled-js.svg | ||
| index.html | ||
| package.json | ||
| tsconfig.json | ||
| vite.config.ts | ||
| yarn.lock | ||
README.md
Deprecation Notice
This project is deprecated, however it still may receive maintenance updates.
PRs for small fixes are more than welcome.
Deploying a new release
Ensure .env.local points to https://app.revolt.chat/api.
cd ~/deployments/revite
git pull
git submodule update
# check:
git status
export REVOLT_SAAS_BRANCH=revite/main
export REMOTE=root@production
scripts/publish.sh
# SSH in and restart revite:
ssh $REMOTE
tmux a -t 4
Revite
Description
This is the web client for Revolt, which is also available live at app.revolt.chat.
Pending Rewrite
The following code is pending a partial or full rewrite:
src/components: components are being migrated to revoltchat/componentssrc/styles: needs to be migrated to revoltchat/componentssrc/lib: this needs to be organised
Stack
Submodule Hint
This project contains submodules. Run git submodule init after you clone this repository to initialize the submodules.
It is also recommended to run git submodule update after you pull from upstream.
Resources
Revite
Revolt
- Revolt Project Board (Submit feature requests here)
- Revolt Testers Server
- Contribution Guide
Quick Start
Get revite up and running locally.
git clone --recursive https://github.com/revoltchat/revite
cd revite
yarn
yarn build:deps
yarn dev
You can now access the client at http://local.revolt.chat:3000.
CLI Commands
| Command | Description |
|---|---|
yarn pull |
Setup assets required for Revite. |
yarn dev |
Start the Revolt client in development mode. |
yarn build |
Build the Revolt client. |
yarn build:deps |
Build external dependencies. |
yarn preview |
Start a local server with the built client. |
yarn lint |
Run ESLint on the client. |
yarn fmt |
Run Prettier on the client. |
yarn typecheck |
Run TypeScript type checking on the client. |
yarn start |
Start a local sirv server with built client. |
yarn start:inject |
Inject a given API URL and start server. |
yarn lint | egrep "no-literals" -B 1 |
Scan for untranslated strings. |
License
Revite is licensed under the GNU Affero General Public License v3.0.