cl0sey/nib-pattern-library

Pattern library for nib Health Funds

nib-pattern-library

Production (production branch)

This is the pattern library for the web at nib. View online. You can also check the current deployment status.

Staging (master branch)

Staging environment. View online. You can also check the current deployment status.

Prerequisites

Required software:

• git
• nodejs
• An editor
• A browser

Installation

1. Open a command prompt

2. Clone from Github - git clone https://github.com/nib-pattern-library/nib-pattern-library.git

3. Change the current directory - cd nib-pattern-library

4. Install node modules - npm install

5. Authorise component to access the Github API by creating a token and adding it to your ~/.netrc file.

   machine api.github.com login password x-oauth-basic

Building

1. Run npm run build
2. Open build/index.html

Editing

1. Get the latest code git pull
2. Run npm run watch
3. Open build/index.html
4. Edit content in the content directory, templates in the templates directory or JavaScript and styles in the components directory.
5. Refresh the page
6. Commit your changes git add -A && git commit -am "msg describing changes"
7. Share your changes git push

The templating language used is EJS.