mirror of
https://github.com/revoltchat/revite.git
synced 2024-11-25 08:30:58 -05:00
Improve Readme to new format, closes #45
This commit is contained in:
parent
7d76a657fa
commit
318b4b2608
1 changed files with 33 additions and 11 deletions
44
README.md
44
README.md
|
@ -1,21 +1,43 @@
|
||||||
# Revite
|
# Revite
|
||||||
|
|
||||||
|
## Description
|
||||||
|
|
||||||
This is the web client for Revolt, which is also available live at [app.revolt.chat](https://app.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 on the client on [our Wekan board](https://wekan.insrt.uk/b/jj3x5C6nbYzM6ERQD/revolt).
|
## Stack
|
||||||
|
|
||||||
Official screenshots of the client are available in [this Google Drive folder](https://drive.google.com/drive/folders/1Ckhl7_9OTTaKzyisrWHzZw1hHj55JwhD).
|
- [Preact](https://preactjs.com/)
|
||||||
|
- [Vite](https://vitejs.dev/)
|
||||||
|
|
||||||
|
## 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
|
||||||
|
|
||||||
|
- [Revite Issue Board](https://github.com/revoltchat/revite/issues)
|
||||||
|
- [Google Drive Folder with Screenshots](https://drive.google.com/drive/folders/1Ckhl7_9OTTaKzyisrWHzZw1hHj55JwhD)
|
||||||
|
|
||||||
|
### Revolt
|
||||||
|
|
||||||
|
- [Revolt Project Board](https://github.com/revoltchat/revolt/discussions) (Submit feature requests here)
|
||||||
|
- [Revolt Testers Server](https://app.revolt.chat/invite/Testers)
|
||||||
|
- [Contribution Guide](https://developers.revolt.chat/contributing)
|
||||||
|
|
||||||
## CLI Commands
|
## CLI Commands
|
||||||
|
|
||||||
* `yarn dev`: Runs a development server.
|
| Command | Description |
|
||||||
|
| ---------------- | -------------------------------------------- |
|
||||||
|
| `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 build`: Creates a production build of the client.
|
## License
|
||||||
|
|
||||||
* `yarn preview`: Starts a local server with the production build.
|
Revite is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/revite/blob/master/LICENSE).
|
||||||
|
|
||||||
* `yarn lint`: Runs ESLint to check project.
|
|
||||||
|
|
||||||
* `yarn fmt`: Runs prettier on source code.
|
|
||||||
|
|
||||||
* `yarn typecheck`: Runs Typescript compiler in noEmit mode.
|
|
||||||
|
|
Loading…
Reference in a new issue