mirror of https://github.com/revoltchat/revite.git synced 2024-11-06 07:25:53 -05:00

Revolt client built with Preact.

Find a file

Paul Makles 83a3585940 chore: add notice		2022-05-07 10:45:18 +01:00
.github	chore: remove highlight.js, use node 16 for ci (#511 )	2022-03-29 20:47:19 +01:00
.vscode	chore(dev): setup chrome user data directory	2021-12-25 10:37:48 +00:00
external	chore: update language definitions	2022-03-29 21:23:34 +01:00
public	chore: add our signing key to assetlinks	2022-03-04 18:28:53 +00:00
scripts	fix: pre-cache to not include extra files	2022-03-25 11:17:04 +00:00
src	chore: add notice	2022-05-07 10:45:18 +01:00
ui	feat: add sc minification + display class names	2022-01-14 18:51:03 +00:00
.babelrc	feat: add sc minification + display class names	2022-01-14 18:51:03 +00:00
.dockerignore	Try to automate Docker builds.	2021-08-30 15:45:18 +01:00
.env	Remove stray console.log and update translations.	2021-09-09 22:39:17 +01:00
.env.build	Remove stray console.log and update translations.	2021-09-09 22:39:17 +01:00
.gitignore	chore(dev): setup chrome user data directory	2021-12-25 10:37:48 +00:00
.gitlab-ci.yml	chore: remove highlight.js, use node 16 for ci (#511 )	2022-03-29 20:47:19 +01:00
.gitmodules	Update submodule origin.	2021-09-04 22:50:03 +01:00
.prettierignore	feat(renderer): add additional languages to cb	2021-12-22 22:11:25 +00:00
.prettierrc.js	chore(languages): Change Tamil flag.	2021-10-31 17:36:26 +00:00
disabled-js.svg	fix(login): finished new login screen	2021-12-25 19:48:48 +01:00
Dockerfile	chore(ci): bump Docker image to node v16	2021-12-20 20:48:27 +00:00
index.html	fix(iOS): actually fix context menus	2022-03-05 14:41:41 +00:00
LICENSE	Changed name to lowercase.	2021-07-08 00:01:27 +02:00
package.json	chore: add "OpenDyslexic" font (#529 )	2022-03-29 20:49:16 +01:00
README.md	chore: update README	2022-04-23 17:25:33 +01:00
tsconfig.json	fix: pre-cache to not include extra files	2022-03-25 11:17:04 +00:00
vercel.json	Make Vercel serve root entrypoint	2021-06-19 18:54:47 +01:00
VERSION	feat(messaging): render masqueraded messages	2021-11-04 20:55:26 +00:00
vite.config.ts	fix(iOS): actually fix context menus	2022-03-05 14:41:41 +00:00
yarn.lock	chore: add "OpenDyslexic" font (#529 )	2022-03-29 20:49:16 +01:00

README.md

Revite

Description

This is the web client for Revolt, which is also available live at app.revolt.chat.

Stack

Preact
Vite

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.