/pod-point-ui-toolkit

A Pod Point prototyping framework

Primary LanguageHTMLMIT LicenseMIT

pod-point-ui-toolkit

npm Build Status

The POD Point frontend framework is a library of base styles and components designed for rapid prototyping.

Installation

npm install --save @pod-point/pod-point-ui-toolkit

Development

First, install all of the Node modules needed:

git clone git@github.com:Pod-Point/pod-point-ui-toolkit.git
cd pod-point-ui-toolkit
npm install

Versioning

Use NPM to create a new version in your PR branch:

npm version [major | minor | patch]

Then you need to push the version commit and the tags up:

git push && git push --tags

Once your version change in package.json is merged into master Travis will deploy this to NPM for you.

Gulp tasks

Gulp and gulp dev - compiles pages, assets and creates Sass sourcemaps

gulp
gulp dev

Gulp watch - compiles pages and assets and spins up a new development server at http://localhost:3000 with /dist as the document root.

gulp watch

Gulp prod - compiles pages and assets, minifies CSS and JS and creates SASS sourcemaps

gulp prod

Documentation

See full docs here