developing.md

Developing Remixer Remote for Web

Setting up your development environment

First you'll need a recent version of Node.js to work with Remixer Remote.

Once node is installed, simply clone our repo (or your fork of it) and run npm install.

git clone [email protected]:material-foundation/material-remixer-remote-web.git
cd material-remixer-remote-web && npm install

Typescript

The source code for Remixer Remote is written in Typescript, and compiled to es5 javascript for distribution.

Building Remixer

Use any of the following npm scripts to build dev or prod versions of Remixer Remote.

# Builds an unminified version of Remixer Remote within the build folder.
npm run build:dev

# Builds a minified version.
npm run build:prod

# Builds both unminified and minified versions.
npm run build

Running the development server

We use weback dev server for hosting and live-reloading of any code changes.

npm run dev
open http://localhost:9000

Linting

# Lint both CSS/LESS using lesshint.
npm run lint:css

# Lint typescript using tslint.
npm run lint:ts

# Lints both css and ts.
npm run lint

Testing and Code Coverage

Testing uses the karma test runner with mocha flavored testing framework. Code coverage is reported by istanbul.

# Run tests and code coverage once.
npm run test

# Run with auto-watch indefinitely.
npm run test:watch