mirror of
https://github.com/revoltchat/revite.git
synced 2024-11-24 16:10:59 -05:00
Revolt client built with Preact.
| .github | ||
| .vscode | ||
| .yarn | ||
| external | ||
| public | ||
| scripts | ||
| src | ||
| .babelrc | ||
| .dockerignore | ||
| .env | ||
| .env.build | ||
| .gitignore | ||
| .gitlab-ci.yml | ||
| .gitmodules | ||
| .prettierignore | ||
| .prettierrc.js | ||
| .yarnrc.yml | ||
| disabled-js.svg | ||
| Dockerfile | ||
| index.html | ||
| LICENSE | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
| vercel.json | ||
| VERSION | ||
| vite.config.ts | ||
| yarn.lock | ||
Revite
Description
This is the web client for Revolt, which is also available live at app.revolt.chat.
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 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 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. |
License
Revite is licensed under the GNU Affero General Public License v3.0.