Skip to content

hook/champions

 
 

Repository files navigation

Icon Champions

Build Status Join the chat at https://gitter.im/hook/champions

Download

Clone this repository with git.

Installation

Install all NPM packages and update packages that need it.

  $ npm install
Windows

If you are developing in a Windows environment, make sure to set your line endings preferences to autocrlf.

Local Development

Run a webpack-dev-server and navigate to localhost:8080 test changes.

  npm start

Environment variables

Name Default value Description
WEBPACK_HOSTNAME localhost Hostname (or IP address) for the dev server
WEBPACK_PORT 8080 Port for the dev server
WEBPACK_OPEN true Open the default browser at the current dev server

Linting and Testing

Periodically lint your code and run tests to ensure basic functionality has not broken. ESLint and SassLint can be enabled inside your IDE for WebStorm, Sublime Text or Atom.

  npm test

Deployment

Lint, Test, Build and publish to gh-pages branch is done automatically by Travis-CI on git push.