Vector is a Matrix web client built using the Matrix React SDK (https://github.com/matrix-org/matrix-react-sdk).
- Install or update
node.jsso that your
npmis at least at version
- Clone the repo:
git clone https://github.com/vector-im/vector-web.git
- Switch to the SDK directory:
- Install the prerequisites:
- Start the development builder and a testing server:
- 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.
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
vector directory and run your own server.
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
too, which isn't expressed in Vector's
package.json. To do this, check out
develop branches of these libraries and then use
npm link to tell Vector
git clone email@example.com:matrix-org/matrix-react-sdk.git
git checkout develop
npm start(to start the dev rebuilder)
- 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
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.
npm build and then mount the
vector directory on your webserver to
actually serve up the app, which is entirely static content.