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/
683 Commits
206 Branches
552 Tags
438 MiB
TypeScript 91.2%
CSS 6.2%
HTML 1.3%
JavaScript 1%
 
 
 
 
Go to file
Kegan Dougal 22369729f9 Remove test feature 2015-10-28 17:42:19 +00:00
docs Actually add the doc 2015-09-17 11:06:50 +01:00
src Remove test feature 2015-10-28 17:42:19 +00:00
vector Switch to webpack 2015-09-25 11:43:28 +01:00
.gitignore Switch to webpack 2015-09-25 11:43:28 +01:00
.modernizr.json Use Modernizr to check for browser compatibility 2015-10-28 17:39:50 +00: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
AUTHORS.rst changelog, authors and contributing files 2015-08-10 18:09:35 +01:00
CHANGES.rst Call initial release 0.1.0 and this release 0.1.1 2015-08-10 18:19:30 +01:00
CONTRIBUTING.rst changelog, authors and contributing files 2015-08-10 18:09:35 +01:00
LICENSE Basic structure of a react SDK and start of an implementation. 2015-06-09 17:40:42 +01:00
README.md spell out how to set up the deps when developing 2015-10-25 12:33:23 +00:00
config.json Add config file for default hs/is urls 2015-10-02 11:48:52 +01:00
package.json Use Modernizr to check for browser compatibility 2015-10-28 17:39:50 +00:00
webpack.config.js Relative-ize paths in webpack config: they're supposed to be relative but sometimes they aren't. 2015-10-23 10:16:00 +01:00

README.md

Vector/Web

Vector is a Matrix web client built using the Matrix React SDK (https://github.com/matrix-org/matrix-react-sdk).

Getting started

  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/vector-im/vector-web.git
  3. Switch to the SDK directory: cd vector-web
  4. Install the prerequisites: npm install
  5. Start the development builder and a testing server: npm start
  6. Wait a few seconds for the initial build to finish.
  7. Open http://127.0.0.1:8080/ in your browser to see your newly built Vector.

With npm start, any changes you make to the source files will cause a rebuild so your changes will show up when you refresh.

For production use, run npm run build to build all the necessary files into the vector directory and run your own server.

Development

For simple tweaks, you can work on any of the source files within Vector with the setup above, and your changes will cause an instant rebuild.

However, all serious development on Vector happens on the develop branch. This typically depends on the develop snapshot versions of matrix-react-sdk and matrix-js-sdk too, which isn't expressed in Vector's package.json. To do this, check out the develop branches of these libraries and then use npm link to tell Vector about them:

  1. git clone git@github.com:matrix-org/matrix-react-sdk.git
  2. cd matrix-react-sdk
  3. git checkout develop
  4. npm install
  5. npm start (to start the dev rebuilder)
  6. cd ../vector-web
  7. Link the react sdk package into the example: npm link path/to/your/react/sdk

Similarly, you may need to npm link path/to/your/js/sdk in your matrix-react-sdk directory.

If you add or remove any components from the Vector skin, you will need to rebuild the skin's index by running, npm run reskindex.

You may need to run npm i source-map-loader in matrix-js-sdk if you get errors about "Cannot resolve module 'source-map-loader'" due to shortcomings in webpack.

Deployment

Just run npm build and then mount the vector directory on your webserver to actually serve up the app, which is entirely static content.