mirrors/element-web
1
0
Fork 0
mirror of https://github.com/element-hq/element-web synced 2024-11-23 01:35:49 +03:00
Code Issues Projects Releases Packages Wiki Activity
A glossy Matrix collaboration client for the web.
93 commits 203 branches 553 tags 406 MiB
TypeScript 91.2%
CSS 6.2%
HTML 1.3%
JavaScript 1%
Find a file
David Baker 3e87e043d6 Fix docs
2015-07-06 18:29:24 +01:00
examples Add example shwing how to customise, make customising work and document all the ways in which browserify will break and how to work around it being dumb. 2015-07-06 14:13:02 +01:00
skins/base Add aria-live=polite to message list view. 2015-07-06 12:22:28 -05:00
src Fix docs 2015-07-06 18:29:24 +01:00
.gitignore gitignore bundle.js too 2015-06-11 18:26:25 +01:00
.npmignore Tweak the example build process. Move example -> examples/trivial to we can have more than one. Update README appropriately. 2015-07-03 15:56:04 +01:00
LICENSE Basic structure of a react SDK and start of an implementation. 2015-06-09 17:40:42 +01:00
package.json Tweak the example build process. Move example -> examples/trivial to we can have more than one. Update README appropriately. 2015-07-03 15:56:04 +01:00
README.md Fix docs 2015-07-06 18:29:24 +01:00

README.md

matrix-react-sdk

This is a react-based SDK for inserting a Matrix chat client into a web page

Getting started with the trivial example

  1. Install or update node.js so that your npm is at least at version 2.0.0
  2. Clone the repo: git clone https://github.com/matrix-org/matrix-react-sdk.git
  3. Switch to the example directory: cd matrix-react-sdk/examples/trivial
  4. Install the prerequisites: npm install
  5. Build the example and start a server: npm start

Now open http://127.0.0.1:8080/ in your browser to see your newly built Matrix client.

Using the example app for development

To work on the CSS and Javascript and have the bundle files update as you change the source files, you'll need to do two extra things:

  1. Link the react sdk package into the example: cd matrix-react-sdk/examples/trivial; npm link ../../
  2. Start a watcher for the CSS files: cd matrix-react-sdk; npm run start:css

Note that you may need to restart the CSS builder if you add a new file. Note that npm start builds debug versions of the the javascript and CSS, which are much larger than the production versions build by the npm run build commands.

IMPORTANT: If you customise components in your application (and hence require react from your app) you must be sure to:

  1. Make your app depend on react directly
  2. If you npm link matrix-react-sdk, manually remove the 'react' directory from matrix-react-sdk's node_modules folder, otherwise browserify will pull in both copies of react which causes the app to break.