Update README.

This commit is contained in:
Paul 2021-06-22 18:41:31 +01:00
parent b1a4604653
commit 01efee817f

View file

@ -1,5 +1,21 @@
The port of the original REVOLT client from Webpack to Vite is roughly 90% done.
# Revite
You can help test the new client at https://vite.revolt.chat
This is the web client for Revolt, which is also available live at [app.revolt.chat](https://app.revolt.chat).
You can track progress of the port on Wekan as usual: https://wekan.insrt.uk/b/jj3x5C6nbYzM6ERQD/revolt
You can track progress on the client on [our Wekan board](https://wekan.insrt.uk/b/jj3x5C6nbYzM6ERQD/revolt).
Official screenshots of the client are available in [this Google Drive folder](https://drive.google.com/drive/folders/1Ckhl7_9OTTaKzyisrWHzZw1hHj55JwhD).
## CLI Commands
* `yarn dev`: Runs a development server.
* `yarn build`: Creates a production build of the client.
* `yarn preview`: Starts a local server with the production build.
* `yarn lint`: Runs ESLint to check project.
* `yarn fmt`: Runs prettier on source code.
* `yarn typecheck`: Runs Typescript compiler in noEmit mode.