cswimr/revite
1
0
Fork 0
mirror of https://github.com/revoltchat/revite.git synced 2024-11-21 14:40:58 -05:00
Code Issues Projects Releases Packages Wiki Activity
revite/README.md
Paul Makles ec8b51f559 chore: repository clean-up
2022-06-09 14:58:39 +01:00

2.7 KiB
Raw Blame History

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/components
  • src/styles: needs to be migrated to revoltchat/components
  • src/context/intermediate: modal system is being rewritten from scratch
  • src/context/revoltjs: client state management needs to be rewritten and include support for concurrent clients
  • src/lib: this needs to be organised
  • src/*.ts(x): half of these files should be moved
  • src/*.d.ts: should be in dedicated types folder

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

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.