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/
71 Commits
202 Branches
553 Tags
455 MiB
TypeScript 91.2%
CSS 6.2%
HTML 1.3%
JavaScript 1%
 
 
 
 
Go to file
David Baker 9aa9a60333 Some checks to see whether stuff is still mounted when adding things. 2015-06-25 17:52:40 +01:00
example Copyright headers (and use strict, while we're at it). 2015-06-23 16:41:25 +01:00
skins/base Limit the number of messages we load into a chat room when we switch to it (or more accurately, switch back to it). 2015-06-25 14:36:24 +01:00
src Some checks to see whether stuff is still mounted when adding things. 2015-06-25 17:52:40 +01:00
.gitignore gitignore bundle.js too 2015-06-11 18:26:25 +01:00
LICENSE Basic structure of a react SDK and start of an implementation. 2015-06-09 17:40:42 +01:00
README.md Add more detail to the getting started instructions. 2015-06-24 17:58:13 +01:00
package.json s/themes/skins/g as we are always describing the whole UI layout here, whereas themes can sometimes just be small cosmetic tweaks (light-on-dark, dark-on-light etc) 2015-06-23 18:28:20 +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 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 your new checkout: cd matrix-react-sdk
  4. Build the CSS: npm install && npm run build:css
  5. Switch to the example: cd example
  6. Build the javascript & copy the CSS: npm install && npm run build && ln -s ../bundle.css ./

Serve the app from within the example directory by running python -m SimpleHTTPServer 8000 and access it at http://127.0.0.1:8000

Using the example app for development

To develop using the example app, you can avoid havign to repeat the above steps each time you change something:

  1. Perform all the steps above
  2. In the matrix-react-sdk directory: npm run start:css
  3. Open a new terminal window in the matrix-react-sdk directory: cd example; npm start

Now, development version of your Javascript and CSS will be rebuilt whenever you change any of the files (although you may need to restart the CSS builder if you add a new file). Note that the debug CSS and Javascript are much, much larger than the production versions.