You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
Aravinth Manivannan f9aa7b52f8
feat: switch to matrix.test.mystiq.app
1 month ago
.github/workflows Add GH Action to build the docker image 11 months ago
doc Add explaining doc 2 months ago
prototypes add prototype to show we can prevent the txn from being aborted on error 1 year ago
scripts fix: set project root 1 month ago
src feat: switch to matrix.test.mystiq.app 1 month ago
.dockerignore chore: optimise Dockerfile 2 years ago
.editorconfig wip 4 years ago
.eslintrc.js implement placeholder replacement so it still works with minification 10 months ago
.gitignore feat: deploy to librepages 1 month ago
.gitlab-ci.yml chore: add GitLab CI definition 2 years ago
.ts-eslintrc.js first draft of fully typescriptified LoginViewModel.ts 2 months ago
.woodpecker.yml fix: secrets 1 month ago
CONTRIBUTING.md remove changelog notes remainder 7 months ago
Dockerfile Required pkg for aarch64 docker build 1 year ago
Dockerfile-dev Required pkg for aarch64 docker build 1 year ago
LICENSE add full license text 2 years ago
Makefile fix: secrets 1 month ago
README.md feat: add ci badge 1 month ago
TODO.md WIP 2 years ago
codestyle.md dont use lookbehind in regular expressions, safari & older firefoxes choke on them 10 months ago
package.json release v0.3.1 2 months ago
tsconfig-declaration.json somewhat works, but not everything we need 9 months ago
tsconfig.json Revert back option 2 months ago
view-gallery.html rearrange assets and main.js to make them run with vite 11 months ago
vite.common-config.js Change directory name 2 months ago
vite.config.js Get the theme-collection id from manifest 3 months ago
vite.sdk-assets-config.js Specify theme as array 2 months ago
vite.sdk-lib-config.js Remove unsued imports 6 months ago
yarn.lock Typescript update to support .mjs files 2 months ago

README.md

status-badge

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

For embedded usage, see the SDK instructions.

If you find this interesting, come and discuss on #hydrogen:matrix.org.

How to use

Hydrogen is deployed to hydrogen.element.io. You can also deploy Hydrogen on your own web server:

  1. Download the latest release package.
  2. Extract the package to the public directory of your web server.
  3. If this is your first deploy:
    1. copy config.sample.json to config.json and if needed, make any modifications (unless you've set up your own sygnal instance, you don't need to change anything in the push section).

    2. Disable caching entirely on the server for:

      • index.html
      • sw.js
      • config.json
      • All theme manifests referenced in the themeManifests of config.json, these files are typically called theme-{name}.json.

      These resources will still be cached client-side by the service worker. Because of this; you'll still need to refresh the app twice before config.json changes are applied.

Set up a dev environment

You can run Hydrogen locally by the following commands in the terminal:

  • yarn install (only the first time)
  • yarn start in the terminal

Now point your browser to http://localhost:3000. If you prefer, you can also use docker.

FAQ

Some frequently asked questions are answered here.