revite/README.md

44 lines
1.6 KiB
Markdown
Raw Normal View History

2021-06-22 13:41:31 -04:00
# Revite
2021-06-18 07:05:01 -04:00
## Description
2021-06-22 13:41:31 -04:00
This is the web client for Revolt, which is also available live at [app.revolt.chat](https://app.revolt.chat).
2021-06-22 04:21:09 -04:00
## Stack
2021-06-22 13:41:31 -04:00
- [Preact](https://preactjs.com/)
- [Vite](https://vitejs.dev/)
2021-06-22 13:41:31 -04:00
## 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
2021-06-22 13:41:31 -04:00
### Revite
2021-06-22 13:41:31 -04:00
- [Revite Issue Board](https://github.com/revoltchat/revite/issues)
- [Google Drive Folder with Screenshots](https://drive.google.com/drive/folders/1Ckhl7_9OTTaKzyisrWHzZw1hHj55JwhD)
2021-06-22 13:41:31 -04:00
### 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
2021-06-22 13:41:31 -04:00
| 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. |
2021-06-22 13:41:31 -04:00
## License
2021-06-22 13:41:31 -04:00
Revite is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/revite/blob/master/LICENSE).