https://github.com/bwindels/brawl-chat

A minimal Matrix chat client, focused on performance and offline functionality.
https://github.com/bwindels/brawl-chat

Last synced: about 1 month ago
JSON representation

A minimal Matrix chat client, focused on performance and offline functionality.

• Host: GitHub
• URL: https://github.com/bwindels/brawl-chat
• Owner: bwindels
• License: apache-2.0
• Archived: true
• Created: 2019-01-09T10:07:21.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2021-05-19T09:35:49.000Z (over 3 years ago)
• Last Synced: 2024-08-01T12:31:47.151Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 6.91 MB
• Stars: 20
• Watchers: 1
• Forks: 2
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-starred - bwindels/brawl-chat - A minimal Matrix chat client, focused on performance and offline functionality. (others)

README

        
This project is continuing at https://github.com/vector-im/hydrogen-web

# Brawl

A minimal [Matrix](https://matrix.org/) chat client, focused on performance and offline functionality.

## Status

Brawl can currently log you in, or pick an existing session, sync already joined rooms, fill gaps in the timeline, and send text messages. Everything is stored locally.

Here's an (outdated) GIF of what that looks like, also see link below to try it out:

![Showing multiple sessions, and sending messages](https://bwindels.github.io/brawl-chat/images/brawl-sending.gif)

## Why

I started writing Brawl both to have a functional matrix client on my aging phone, and to play around with some ideas I had how to use indexeddb optimally in a matrix client.

For every interaction or network response (syncing, filling a gap), Brawl starts a transaction in indexedb, and only commits it once everything went well. This helps to keep your storage always in a consistent state. As little data is kept in memory as well, and while scrolling in the above GIF, everything is loaded straight from the storage.

If you find this interesting, feel free to reach me at `@bwindels:matrix.org`.

# How to use

You can [try Brawl here](https://bwindels.github.io/brawl/), or try it locally by running `yarn install` (only the first time) and `yarn start` in the terminal, and point your browser to `http://localhost:3000`.