Default skin for matrix-react-sdk
  • JavaScript 86.2%
  • CSS 13.6%
  • HTML 0.2%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2015-10-28 18:23:17 +00:00
examples/custom A bit more in the view file itself 2015-10-01 18:09:40 +01:00
src s/getMembersWithMemership/getMembersWithMembership/g 2015-10-24 01:45:16 +01:00
.gitignore switch to webpack 2015-09-25 12:44:12 +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
index.html Bundle our skin css files up, although with no particularly graceful way of including css or assets from parent skins yet. 2015-09-15 14:47:29 +01:00
LICENSE Basic structure of a react SDK and start of an implementation. 2015-06-09 17:40:42 +01:00
package.json bump react sdk dep to 0.0.2 2015-10-28 18:23:17 +00:00
README.md Update README and custom example 2015-10-01 18:00:10 +01:00
webpack.config.js switch to webpack 2015-09-25 12:44:12 +01:00

matrix-react-skin

This package provides a basic skin and Matrix client using the matrix-react-sdk.

Getting started

To build and start a server serving the basic client:

  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/matrix-org/matrix-react-skin.git
  3. Switch to the SDK directory: cd matrix-react-sdk
  4. Install the prerequisites: npm install
  5. Build the example and start a server: npm start

Now open http://127.0.0.1:8080/ in your browser to see your newly built Matrix client.

Components of This Package

This package comprises the following:

  • A basic skin in src/skins/base. This contains the HTML (in React JSX) and CSS that's presented in the client. This matches the controller logic in matrix-react-sdk.
  • The containing app source in src/app. The index.js file here imports matrix-react-sdk and loads the base skin from this package. It then asks the sdk for the MatrixChat component and uses React to render it into the page.
  • The bootstrap HTML for the app in index.html. This imports the javascript bundle file that gets built in the build process as well as the CSS bundle file. It contains basic skeleton HTML and an element where the app gets rendered.
  • The package manifest and build instructions in package.json. This contains all the commands used for building the source files, javascript and CSS bundles.
  • The webpack config in webpack.config.json which contains the basic parameters webpack needs to build the bundled javascript.

Building On Top of matrix-react-skin

See the README.md file in matrix-react-sdk for more on making an application with the react SDK and basic skin. An example of building a derived skin, is provided in examples/custom and explained in examples/custom/README.md.