Common styles and pattern library for daptiv. You can view the style guide here.
Style-guide is available as bower package. This can be included by creating an entry in your bower.json file with the url https://github.com/daptiv/style-guide.git#VERSION
where VERSION is the version you care to use.
- First install dependencies
npm install && bundle install
- For development, run:
grunt serve
this starts a local web server and a watch task. - In a browser, go to:
http://localhost:8888/style-guide
this will automatically refresh when changes are made.
We use pullquester to create pull requests. It provides all the important information for requests and instructions on how to publish changes after the pull request is complete.
- Pull latest master:
git checkout master && git pull
- Run
npm version patch
IMPORTANT NOTE: Before publishing you need to have a npm account. Once you have an account, please create a pull request adding yourself to the CONTRIBUTORS file referencing one of the owners to review.
- Pull latest master:
git checkout master && git pull
- log in to npm
npm login
- publish the package
npm publish
Some versions of npm do not correctly call the postversion
script. If you run npm version and all it outputs to the command line is a version number, you are running one of the affected versions of npm.
In the event that the postversion
script is not run, simply run npm run-script postversion
Running npm version
will:
- Update package.json's version according to the rule provided. (most of the time by incrementing patch number)
- Commit the change to package.json and tag the resulting commit with the same version
- Push the commit and tag up to github.
- Run
grunt publish
which will, in turn:- Build the site
- Publish the newly built site to the
gh-pages
branch - Push the
gh-pages
branch to github, updating the style guide site