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.
Go to file
Prathap-P 57b6c45e34
Ensured more subtleness in the readme file.
2021-04-30 13:40:10 +05:30
assets remove debug output in DOM 2021-03-04 21:53:35 +01:00
doc some notes wrt to ideas for read receipts 2021-03-18 20:22:02 +01:00
prototypes more prototypes 2021-03-08 14:17:31 +01:00
scripts convert post-install script to CJS so we can use require.resolve 2021-03-08 14:40:21 +01:00
src Merge pull request #281 from vector-im/bwindels/fix-updates 2021-03-18 19:02:45 +00:00
.editorconfig wip 2019-02-17 23:58:01 +01:00
.eslintrc.js allow empty blocks 2021-02-11 21:08:43 +01:00
.gitignore ignore build packages 2020-10-08 14:19:02 +02:00
Dockerfile Add Dockerfile 2020-10-21 13:01:16 +02:00
LICENSE add full license text 2020-08-05 18:40:45 +02:00
README.md Ensured more subtleness in the readme file. 2021-04-30 13:40:10 +05:30
TODO.md WIP 2020-08-05 18:17:35 +01:00
codestyle.md notes on codestyle 2020-11-20 16:39:16 +01:00
index.html console logger for local dev 2021-03-01 15:07:24 +01:00
package.json release v0.1.39 2021-03-15 17:20:57 +01:00
yarn.lock update caniuse to have up to date browser definitions for build script 2021-02-17 11:41:06 +01:00

README.md

Hydrogen

A minimal Matrix chat client, focused on performance, offline functionality, and broad browser support. This is work in progress and not yet ready for primetime. Bug reports are welcome, but please don't file any feature requests or other missing things to be on par with Element Web.

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, come and discuss on #hydrogen:matrix.org.

How to use

Hydrogen is deployed to hydrogen.element.io. You can run it locally yarn install (only the first time) and yarn start in the terminal, and point your browser to http://localhost:3000. If you prefer, you can also use docker.

Hydrogen uses symbolic links in the codebase, so if you are on Windows, have a look at making git & symlinks work there.

FAQ

Some frequently asked questions are answered here.