This repository has been archived on 2022-08-19. You can view files and clone it, but cannot push or open issues or pull requests.
hydrogen-web/README.md

22 lines
1.2 KiB
Markdown
Raw Normal View History

2019-06-15 03:28:39 +05:30
# Brawl
2019-09-08 14:22:06 +05:30
A minimal [Matrix](https://matrix.org/) chat client, focused on performance, offline functionality and working on my Lumia 950 Windows Phone.
2019-01-09 15:40:33 +05:30
## Status
2019-09-08 14:22:06 +05:30
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.
![Showing multiple sessions, and sending messages](https://bwindels.github.io/brawl-chat/images/brawl-sending.gif)
2019-02-11 02:32:42 +05:30
2019-09-08 14:22:06 +05:30
## Why
2019-02-13 18:40:23 +05:30
2019-09-08 15:24:51 +05:30
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.
2019-02-13 18:40:23 +05:30
2019-09-08 14:22:06 +05:30
If you find this interesting, feel free to reach me at `@bwindels:matrix.org`.
2019-09-08 15:24:18 +05:30
# How to use
I haven't made a deployment script yet for this, so for now you need to locally `yarn start` or `npm start` and point your browser to `http://localhost:3000`.