Hydrogen

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

This repository contains modifications Peepee.Party have made to Hydrogen. All changes made to Hydrogen by Peepee.party are licensed under BSD-3-Clause. In terms of the original Apache-2.0, the only difference is that you don't have to add a "prominent notice" stating that you have made modifications to our modifications of the original code. You can view our modifications to the code by looking at the timeline of this Fossil repository.

Goals

Hydrogen's goals are:

• Work well on desktop as well as mobile browsers
• UI components can be easily used in isolation
• It is a standalone webapp, but can also be easily embedded into an existing website/webapp to add chat capabilities.
• Loading (unused) parts of the application after initial page load should be supported

If you find this interesting, visit the original git repo at github.com/element-hq/hydrogen-web.

How to use

Our modified version of Hydrogen is deployed at matrix.peepee.party. You can also deploy Hydrogen on your own web server:

Set up a dev environment

Install NodeJS:

OpenBSD: pkg_add node

On some systems, you may need to install npm separately:

FreeBSD: pkg install npm

Install yarn:

Globally: npm install --global yarn

Within the project: npm install yarn (this is how it should be, but it's not what Matrix.org did)

Now you can run Hydrogen locally with the following commands in the terminal:

• yarn install (first time only)
• yarn start

Now point your browser to http://localhost:3000.

FAQ

Some frequently asked questions are answered here.