OpenCloud
/
riot-web
mirror of https://github.com/vector-im/riot-web
1
0
Fork 0
Code Issues Releases Wiki Activity
A web client for Matrix used to replace WhatsApp https://riot.opencloud.lu/
82 Commits
202 Branches
553 Tags
455 MiB
TypeScript 91.2%
CSS 6.2%
HTML 1.3%
JavaScript 1%
 
 
 
 
Go to file
David Baker 275286801b Add npm link to the README 2015-07-03 16:15:23 +01:00
examples/trivial 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
skins/base Add desktop notifications, overridable in the same way as other components (although it's not a react component). Also extend the flux dispatcher a little to be less dumb about dispatching while something else is already dispatching. 2015-07-03 11:12:54 +01:00
src Only highlight room list for messages where we notify - this may want to be an option in the react client potentially. 2015-07-03 11:36:44 +01:00
.gitignore
…
.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
…
README.md Add npm link to the README 2015-07-03 16:15:23 +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

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/example; 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.