designjockey / styleguide

Namely Styleguide

Namely Styleguide (a.k.a Namely-UI / Namely-Bootstrap)

This is the styleguide app to document all the components and patterns for Namely.

Getting Started

1. Clone the repo and cd into the directory
2. Install dependencies

$ npm install
$ npm install -g karma-cli
$ gem install scss-lint

3. Serve app

$ npm start

To serve on a port other than 8080:

$ gulp --port 8081

Testing

To run test suite once:

$ npm test

To keep test suite running and watching:

$ karma start

With Chrome as browser (recommended):

karma start --browsers Chrome

Packaging Files for Production

To create the main js and css file that are to be used by Namely and other properties:

$ npm run compile

This runs every component found in src/js/components/ through Babel and places it in the dist/ directory, including any sub-directories. Then it grabs the base namely-ui module from lib/namely-ui.js to run that through Babel and place it in dist/ as well. Finally, it grabs lib/namely-ui.scss, compiles it to css, autoprefixes, and minifies it before placing it in dist/.