mirrors/element-web
1
0
Fork 0
mirror of https://github.com/element-hq/element-web synced 2024-11-29 04:48:50 +03:00
Code Issues Projects Releases Packages Wiki Activity

Merge pull request #1137 from vector-im/rav/update_README

Browse source 
Update README to include `npm install` in react-sdk
This commit is contained in:
Richard van der Hoff 2016-03-14 12:48:58 +00:00
commit 6215326f8e
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -10,6 +10,9 @@ Getting started
1. Clone the repo: `git clone https://github.com/vector-im/vector-web.git` 1. Clone the repo: `git clone https://github.com/vector-im/vector-web.git`
1. Switch to the vector directory: `cd vector-web` 1. Switch to the vector directory: `cd vector-web`
1. Install the prerequisites: `npm install` 1. Install the prerequisites: `npm install`
1. If you are using the `develop` branch of vector, you will probably need to
rebuild one of the dependencies, due to https://github.com/npm/npm/issues/3055:
`(cd node_modules/matrix-react-sdk && npm install)`
1. Start the development builder and a testing server: `npm start` 1. Start the development builder and a testing server: `npm start`
1. Wait a few seconds for the initial build to finish (the command won't 1. Wait a few seconds for the initial build to finish (the command won't
terminate: it's running a web server for you). terminate: it's running a web server for you).
@ -48,14 +51,13 @@ webserver to actually serve up the app, which is entirely static content.
Development Development
=========== ===========
For simple tweaks, you can work on any of the source files within Vector with the For simple tweaks, you can work on any of the source files within Vector with
setup above, and your changes will cause an instant rebuild. the setup above, and your changes will cause an instant rebuild.
However, all serious development on Vector happens on the `develop` branch. This typically However, much of the functionality in Vector is actually in the
depends on the `develop` snapshot versions of `matrix-react-sdk` and `matrix-js-sdk` `matrix-react-sdk` and `matrix-js-sdk` modules. It is possible to set these up
too, which can't be installed automatically due to https://github.com/npm/npm/issues/3055. in a way that makes it easy to track the `develop` branches in git and to make
To get the right dependencies, check out the `develop` branches of these libraries and local changes without having to manually rebuild each time.
then use `ln -s` to tell Vector about them:
[Be aware that there may be problems with this process under npm version 3.] [Be aware that there may be problems with this process under npm version 3.]