For-Legacy-Web: The Legacy Web Client for Revolt Chat

Introduction

For-Legacy-Web, formerly known as Revite for Revolt, is the legacy web client for Revolt, a modern communication platform. This project serves as the web interface for users to interact with the Revolt chat service, and it is also available live at app.revolt.chat. While this project is officially deprecated, it continues to receive maintenance updates, and contributions for small fixes are highly welcomed. The client is built using a modern stack, leveraging Preact and Vite for its frontend architecture. It is currently undergoing a partial or full rewrite, with components being migrated to revoltchat/components.

Installation

To get For-Legacy-Web (Revite) up and running locally, follow these quick start steps:

First, clone the repository, ensuring to include submodules:

git clone --recursive https://github.com/revoltchat/revite
cd revite

After cloning, initialize and update the submodules if you haven't already:

git submodule init
git submodule update

Next, install the project dependencies and build external dependencies:

yarn
yarn build:deps

Finally, start the development server:

yarn dev

You can now access the client at http://local.revolt.chat:3000.

Examples

For-Legacy-Web provides several CLI commands to streamline development and maintenance. Here are some of the most commonly used commands:

• yarn dev: Starts the Revolt client in development mode, enabling live reloading and developer tools.
• yarn build: Compiles the Revolt client for production, optimizing assets and code.
• yarn lint: Runs ESLint across the client codebase to identify and report on patterns found in JavaScript code.
• yarn typecheck: Executes TypeScript type checking on the client to ensure type safety and catch potential errors early.

These commands facilitate various stages of the development workflow, from local development to preparing for deployment.

Why Use It

Despite its deprecated status, For-Legacy-Web (Revite) offers valuable insights and opportunities. It provides a functional web client for the Revolt chat platform, allowing users and developers to explore its features. For developers, it serves as an excellent example of a real-world application built with Preact and Vite, offering a chance to understand frontend architecture in a chat application context. Furthermore, the project actively welcomes contributions for small fixes, presenting an opportunity to engage with an open-source project and contribute to its ongoing maintenance.

Links

Here are some important links related to For-Legacy-Web (Revite) and the Revolt ecosystem:

• GitHub Repository: https://github.com/stoatchat/for-legacy-web
• Live Client: https://app.revolt.chat
• Revite Issue Board: https://github.com/revoltchat/revite/issues
• Revolt Testers Server: https://app.revolt.chat/invite/Testers
• Contribution Guide: https://developers.revolt.chat/contributing
• Preact Official Website: https://preactjs.com/
• Vite Official Website: https://vitejs.dev/
• Revoltchat Components: https://github.com/revoltchat/components
• License (AGPL-3.0): https://github.com/revoltchat/revite/blob/master/LICENSE