Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/revoltchat/desktop
Revolt Desktop App
https://github.com/revoltchat/desktop
desktop electron javascript revolt
Last synced: 6 days ago
JSON representation
Revolt Desktop App
- Host: GitHub
- URL: https://github.com/revoltchat/desktop
- Owner: revoltchat
- License: agpl-3.0
- Created: 2021-08-01T13:46:44.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-10-24T18:16:42.000Z (2 months ago)
- Last Synced: 2024-12-15T22:00:08.270Z (20 days ago)
- Topics: desktop, electron, javascript, revolt
- Language: TypeScript
- Homepage:
- Size: 2.13 MB
- Stars: 818
- Watchers: 25
- Forks: 101
- Open Issues: 34
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-starred - revoltchat/desktop - Revolt Desktop App (TypeScript)
- awesome-starred - revoltchat/desktop - Revolt Desktop App (TypeScript)
README
# Revolt Desktop
## ⚠️ Deprecation notice ⚠️
This project will soon be deprecated in favour of a new desktop app built with Tauri. You can follow progress [here](https://github.com/revoltchat/frontend/issues/14).
## Description
This is a desktop application for Revolt built on Electron.
## Stack
- [Electron](https://electronjs.org/)
- [Electron Builder](https://www.electron.build/)
## Resources
### Revolt Desktop
- [Revolt Desktop Issue Board](https://github.com/revoltchat/desktop/issues)
### 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)
## Quick Start
Get Revolt Desktop up and running locally.
```
git clone https://github.com/revoltchat/desktop
cd desktop
yarn
yarn build:bundle
yarn start
```
## CLI Commands
| Command | Description |
| ------------------- | ----------------------------------------------------------------------------------- |
| `yarn build:bundle` | Builds the application bundle from TypeScript files. |
| `yarn watch:bundle` | Watches TypeScript files for changes and rebuilds the application bundle on change. |
| `yarn start` | Starts the application. |
| `yarn eb` | Runs electron-builder. |
| `yarn release` | Prepares a release. Requires a valid .env file. |
| `yarn clean` | Cleans the application bundle. |
There are also numerous OS-specific commands related to building and testing, all prefixed with `yarn`:
- `build:linux` `build:mac`, `build:windows`
- Builds the application for the specified platform.
## License
Revolt Desktop is licensed under the [GNU Affero General Public License v3.0](https://github.com/revoltchat/desktop/blob/master/LICENSE).