2015-07-22 13:45:01 +08:00
|
|
|
Vector/Web
|
|
|
|
|
==========
|
2015-06-10 00:40:42 +08:00
|
|
|
|
2015-07-22 13:45:01 +08:00
|
|
|
Vector is a Matrix web client built using the Matrix React SDK (https://github.com/matrix-org/matrix-react-sdk).
|
2015-06-24 23:33:53 +08:00
|
|
|
|
2015-07-22 13:45:01 +08:00
|
|
|
Getting started
|
|
|
|
|
===============
|
2015-06-25 00:58:13 +08:00
|
|
|
|
|
|
|
|
1. Install or update `node.js` so that your `npm` is at least at version `2.0.0`
|
2015-07-28 23:30:01 +08:00
|
|
|
2. Clone the repo: `git clone https://github.com/vector-im/vector-web.git`
|
|
|
|
|
3. Switch to the SDK directory: `cd vector-web`
|
2015-07-03 22:56:04 +08:00
|
|
|
4. Install the prerequisites: `npm install`
|
2015-10-01 23:02:44 +08:00
|
|
|
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.
|
2015-06-25 00:58:13 +08:00
|
|
|
|
2015-10-02 23:44:35 +08:00
|
|
|
With `npm start`, any changes you make to the source files will cause a rebuild so
|
2015-10-01 23:02:44 +08:00
|
|
|
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.
|
2015-06-25 00:58:13 +08:00
|
|
|
|
2015-07-22 13:45:01 +08:00
|
|
|
Development
|
|
|
|
|
===========
|
2015-10-25 19:56:29 +08:00
|
|
|
|
|
|
|
|
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`
|
2015-10-25 20:35:52 +08:00
|
|
|
too, which isn't handled by Vector's `package.json`. To get the right dependencies, check out
|
2015-10-25 19:56:29 +08:00
|
|
|
the `develop` branches of these libraries and then use `npm link` to tell Vector
|
|
|
|
|
about them:
|
2015-06-25 00:58:13 +08:00
|
|
|
|
2015-10-25 20:33:13 +08:00
|
|
|
1. `git clone git@github.com:matrix-org/matrix-react-sdk.git`
|
|
|
|
|
2. `cd matrix-react-sdk`
|
|
|
|
|
3. `git checkout develop`
|
|
|
|
|
4. `npm install`
|
2015-11-22 09:13:08 +08:00
|
|
|
5. `npm run build`
|
|
|
|
|
6. `npm start` (to start the dev rebuilder)
|
|
|
|
|
7. `cd ../vector-web`
|
|
|
|
|
8. Link the react sdk package into the example:
|
2015-10-01 23:02:44 +08:00
|
|
|
`npm link path/to/your/react/sdk`
|
2015-06-24 23:33:53 +08:00
|
|
|
|
2015-10-25 19:56:29 +08:00
|
|
|
Similarly, you may need to `npm link path/to/your/js/sdk` in your `matrix-react-sdk`
|
|
|
|
|
directory.
|
|
|
|
|
|
2015-10-01 23:02:44 +08:00
|
|
|
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`.
|
2015-07-08 00:46:06 +08:00
|
|
|
|
2015-10-11 01:51:22 +08:00
|
|
|
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.
|
|
|
|
|
|
2015-09-20 03:17:45 +08:00
|
|
|
Deployment
|
|
|
|
|
==========
|
|
|
|
|
|
2015-11-22 09:13:08 +08:00
|
|
|
Just run `npm run build` and then mount the `vector` directory on your webserver to
|
2015-10-01 23:02:44 +08:00
|
|
|
actually serve up the app, which is entirely static content.
|
2015-07-08 01:27:34 +08:00
|
|
|
|
2015-12-04 02:24:44 +08:00
|
|
|
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.
|
