Go to file

Richard van der Hoff 97dd4e2e6b Merge branch 'develop' into rav/olm Conflicts: webpack.config.js		2015-12-03 18:28:50 +00:00
docs	Actually add the doc	2015-09-17 11:06:50 +01:00
src	Merge pull request #465 from vector-im/file_uploads	2015-12-03 10:58:03 +00:00
vector	uh, actually include Open Sans webfont :-/	2015-12-02 15:13:41 +00:00
.gitignore	Run the CSS through webpack so we can pull in CSS files from modules with require rather than symlinking into the node_module directory which is breaking people on different npm versions.	2015-12-01 18:05:43 +00:00
.modernizr.json	Add objectfit and localstorage to browser features	2015-10-29 15:56:03 +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	changelog	2015-10-28 18:37:53 +00: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	Notes on building a crypto-enabled version	2015-12-03 18:25:20 +00:00
config.json	Add config file for default hs/is urls	2015-10-02 11:48:52 +01:00
package.json	Merge branch 'develop' into require-css	2015-12-02 10:26:26 +00:00
webpack.config.js	Merge branch 'develop' into rav/olm	2015-12-03 18:28:50 +00: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

Install or update node.js so that your npm is at least at version 2.0.0
Clone the repo: git clone https://github.com/vector-im/vector-web.git
Switch to the SDK directory: cd vector-web
Install the prerequisites: npm install
Start the development builder and a testing server: npm start
Wait a few seconds for the initial build to finish.
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 handled by Vector's package.json. To get the right dependencies, check out the develop branches of these libraries and then use npm link to tell Vector about them:

git clone git@github.com:matrix-org/matrix-react-sdk.git
cd matrix-react-sdk
git checkout develop
npm install
npm run build
npm start (to start the dev rebuilder)
cd ../vector-web
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 run build and then mount the vector directory on your webserver to actually serve up the app, which is entirely static content.

Enabling encryption

To build a version of vector with the (experimental) support for end-to-end encryption, install the olm module with npm i https://matrix.org/packages/npm/olm/olm-0.1.0.tgz before running npm start. The olm library will be detected and used if available.