OpenCloud
/
riot-web
mirror of https://github.com/vector-im/riot-web
1
0
Fork 0
Code Issues Releases Wiki Activity

update README

pull/21833/head
Bruno Windels 2018-07-27 13:50:58 +02:00
parent b3473a7220
commit a4e7b14728
2 changed files with 8 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -34,18 +34,16 @@ puppeteer.launch({headless: false});
## How to run
### Setup
- install synapse with `sh synapse/install.sh`, this fetches the master branch at the moment. If anything fails here, please refer to the synapse README to see if you're missing one of the prerequisites.
- install riot with `sh riot/install.sh`, this fetches the master branch at the moment.
- install dependencies with `npm install` (will download copy of chrome)
- have riot-web running on `localhost:8080`
- have a local synapse running at `localhost:8008`
Run `sh install.sh`. This will:
- install synapse, fetches the master branch at the moment. If anything fails here, please refer to the synapse README to see if you're missing one of the prerequisites.
- install riot, this fetches the master branch at the moment.
- install dependencies (will download copy of chrome)
### Run tests
Run tests with `sh run.sh`.
You should see the terminal split with on top the server output (both riot static server, and synapse), and on the bottom the tests running.
Developer Guide
===============

3
install.sh Normal file
View File

@ -0,0 +1,3 @@
sh synapse/install.sh
sh riot/install.sh
npm install