OpenCloud
/
element-web
mirror of https://github.com/vector-im/element-web
1
0
Fork 0
Code Issues Releases Wiki Activity
583 Commits
206 Branches
552 Tags
495 MiB
TypeScript 91.2%
CSS 6.2%
HTML 1.3%
JavaScript 1%
 
 
 
 
Go to file
David Baker df39c3a281 Changes from PR feedback 2015-10-02 16:44:35 +01:00
docs Actually add the doc 2015-09-17 11:06:50 +01:00
src Changes from PR feedback 2015-10-02 16:44:35 +01: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
.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 Changes from PR feedback 2015-10-02 16:44:35 +01:00
config.json Add config file for default hs/is urls 2015-10-02 11:48:52 +01:00
package.json Add config file for default hs/is urls 2015-10-02 11:48:52 +01:00
webpack.config.js Switch to webpack 2015-09-25 11:43:28 +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

You can work on any of the source files within Vector with the setup above, and your changes will cause an instant rebuild. If you also need to make changes to the react sdk, you can:

  1. Link the react sdk package into the example: npm link path/to/your/react/sdk
  2. Start the development rebuilder in your react SDK directory: npm start

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.

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.