mirror of
https://github.com/revoltchat/revite.git
synced 2024-11-21 22:50:59 -05:00
Revolt client built with Preact.
.github | ||
.vscode | ||
external | ||
packages | ||
public | ||
scripts | ||
src | ||
.babelrc | ||
.dockerignore | ||
.env | ||
.env.build | ||
.gitignore | ||
.gitmodules | ||
.npmrc | ||
.prettierignore | ||
.prettierrc.js | ||
.yarnrc.yml | ||
disabled-js.svg | ||
Dockerfile | ||
index.html | ||
LICENSE | ||
package.json | ||
pnpm-lock.yaml | ||
pnpm-workspace.yaml | ||
README.md | ||
tsconfig.json | ||
vite.config.ts |
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
pnpm i
pnpm build:deps
pnpm dev
You can now access the client at http://local.revolt.chat:3000.
CLI Commands
Command | Description |
---|---|
pnpm pull |
Setup assets required for Revite. |
pnpm dev |
Start the Revolt client in development mode. |
pnpm build |
Build the Revolt client. |
pnpm build:deps |
Build external dependencies. |
pnpm build:all |
Build everything. |
pnpm preview |
Start a local server with the built client. |
pnpm lint |
Run ESLint on the client. |
pnpm fmt |
Run Prettier on the client. |
pnpm typecheck |
Run TypeScript type checking on the client. |
pnpm start |
Start a local sirv server with built client. |
pnpm start:inject |
Inject a given API URL and start server. |
pnpm lint | egrep "no-literals" -B 1 |
Scan for untranslated strings. |
License
Revite is licensed under the GNU Affero General Public License v3.0.