Commit 1312ba5

Building From Source

1. Clone the repo: `git clone https://github.com/vector-im/riot-web.git`.

1. Switch to the riot-web directory: `cd riot-web`.

1. If you're using the `develop` branch then it is recommended to set up a proper

development environment ("Setting up a dev environment" below) however one can

install the develop versions of the dependencies instead:

```bash

scripts/fetch-develop.deps.sh

```

to these dependencies - the simplest way is to re-run the script, but you can also

manually update and rebuild them:

```bash

cd matrix-js-sdk

git pull

cd ../matrix-react-sdk

git pull

```

Or just use https://riot.im/develop - the continuous integration release of the

develop branch. (Note that we don't reference the develop versions in git directly

due to https://github.com/npm/npm/issues/3055.)

1. Configure the app by copying `config.sample.json` to `config.json` and

modifying it (see below for details).

a version-specific directory containing all the files that need to go on your

web server.

which will build all the necessary files into the `webapp` directory. The version of Riot

will not appear in Settings without using the dist script. You can then mount the

`webapp` directory on your webserver to actually serve up the app, which is entirely static content.

static in the HTML and an absolute URL (and HTTP rather than HTTPS), so it's

not possible for this to be an option in config.json. If you'd like to change

it, you can build Riot as above, but run

Alternatively, you can edit the `og:image` meta tag in `index.html` directly

each time you download a new version of Riot.

To run as a desktop app:

1. Follow the instructions in 'Building From Source' above, but run

2. Install electron and run it:

```bash

```

To build packages, use electron-builder. This is configured to output:

brew install wine --without-x11

brew install mono

brew install gnu-tar

For other packages, use electron-builder manually. For example, to build a package

* @asdf:matrix.org points out that you can use nativefier and it just works(tm)

nativefier https://riot.im/app/

higher and lower level React components useful for building Matrix communication

apps using React.

the `component-index.js` for the app (used in future for skinning).

Please note that Riot is intended to run correctly without access to the public

git clone https://github.com/matrix-org/matrix-js-sdk.git

pushd matrix-js-sdk

git checkout develop

git clone https://github.com/matrix-org/matrix-react-sdk.git

pushd matrix-react-sdk

git checkout develop

git clone https://github.com/vector-im/riot-web.git

cd riot-web

git checkout develop

Wait a few seconds for the initial build to finish; you should see something like:

automatically picked up by webpack and built.

If you add or remove any components from the Riot skin, you will need to rebuild

If any of these steps error with, `file table overflow`, you are probably on a mac

which has a very low limit on max open files. Run `ulimit -Sn 1024` and try again.

* Make sure you have Chrome installed (a recent version, like 59)

* Make sure you have `matrix-js-sdk` and `matrix-react-sdk` installed and

built, as above

The above will run the tests under Chrome in a `headless` mode.

You can also tell karma to run the tests in a loop (every time the source

test-multi`. This also gives you the option of running the tests in 'debug'

mode, which is useful for stepping through the tests in the developer tools.

1. Check if the import ``import { _t } from 'matrix-react-sdk/lib/languageHandler';`` is present. If not add it to the other import statements. Also import `_td` if needed.

1. Add ``_t()`` to your string. (Don't forget curly braces when you assign an expression to JSX attributes in the render method). If the string is introduced at a point before the translation system has not yet been initialized, use `_td()` instead, and call `_t()` at the appropriate time.

1. If you added a string with a plural, you can add other English plural variants to ``src/i18n/strings/en_EN.json`` (remeber to edit the one in the same project as the source file containing your new translation).

1. Edit every occurrence of the string inside `_t()` and `_td()` in the JSX files.

"prunei18n": "matrix-prune-i18n",

"build:res": "node scripts/copy-res.js",

"build:modernizr": "modernizr -c .modernizr.json -d src/vector/modernizr.js",

"build:bundle": "cross-env NODE_ENV=production webpack -p --progress --bail --mode production",

"build:bundle:dev": "webpack --progress --bail --mode development",

"dist": "scripts/package.sh",

"install:electron": "install-app-deps",

"start:res": "node scripts/copy-res.js -w",

"start:js": "webpack-dev-server --host=0.0.0.0 --output-filename=bundles/_dev_/[name].js --output-chunk-filename=bundles/_dev_/[name].js -w --progress --mode development",

"start:js:prod": "cross-env NODE_ENV=production webpack-dev-server -w --progress",

"lint": "eslint src/",

"lintall": "eslint src/ test/",

"clean": "rimraf lib webapp electron_app/dist",

"test": "karma start --single-run=true --autoWatch=false --browsers ChromeHeadless",

"test-multi": "karma start"

},

for i in matrix-js-sdk matrix-react-sdk

depver=`cat package.json | jq -r .dependencies[\"$i\"]`

if [ "$depver" != "$latestver" ]

then

echo "The latest version of $i is $latestver but package.json depends on $depver"

release="${1#v}"

tag="v${release}"

cd electron_app

git commit package.json -m "$tag"

cd ..

exec ./node_modules/matrix-js-sdk/release.sh -u vector-im -z "$orig_args"

pushd "$builddir"

fi

echo "$repo set to branch "`git -C "$repo" rev-parse --abbrev-ref HEAD`

}

dodep matrix-org matrix-js-sdk

echo -en 'travis_fold:end:matrix-js-sdk\r'

dodep matrix-org matrix-react-sdk

echo -en 'travis_fold:end:matrix-react-sdk\r'

mkdir -p node_modules/.bin

ln -sfv ../matrix-react-sdk/scripts/reskindex.js node_modules/.bin/reskindex