README.md

Revolt Desktop

Description

This is a desktop application for Revolt built on Electron.

Stack

• Electron
• Electron Builder

Resources

Revolt Desktop

• Revolt Desktop Issue Board

Revolt

• Revolt Project Board (Submit feature requests here)
• Revolt Testers Server
• Contribution Guide

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.