Lightweight matrix client.
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:
- Download the latest release package.
- Extract the package to the public directory of your web server.
- If this is your first deploy:
-
copy
config.sample.json
toconfig.json
and if needed, make any modifications (unless you've set up your own sygnal instance, you don't need to change anything in thepush
section). -
Disable caching entirely on the server for:
index.html
sw.js
config.json
- All theme manifests referenced in the
themeManifests
ofconfig.json
, these files are typically calledtheme-{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:
git clone https://github.com/vector-im/hydrogen-web
cd hydrogen-web
yarn install
(only the first time)或者npm installyarn start
in the terminal或者npm start
Now point your browser to http://localhost:3000
.
PS: You need nodejs, running yarn on top of any other js platform is not supported.
FAQ
Some frequently asked questions are answered here.
from https://github.com/vector-im/hydrogen-web
------------------------------------------------------------
This is Matrix.(a chat tool)
Matrix is an open source project that publishes the
Matrix open standard for secure, decentralised, real-time communication, and its Apache licensed
reference implementations.
Maintained by the non-profit Matrix.org Foundation, we aim
to create an open platform which is as independent, vibrant and evolving as the Web itself... but for communication.
As of June 2019, Matrix is out of beta, and the protocol is fully suitable for production usage.
from https://matrix.org/
(https://matrix.org/clients/
https://matrix.org/docs/projects/client/element-ios
https://matrix.org/docs/projects/client/element-android
https://matrix.org/docs/projects/try-matrix-now/
https://github.com/matrix-org)
No comments:
Post a Comment