README.md

CJ UI Boilerplate

CJ UI Boilerplate is a front-end resource for quickly getting into the development of fast, robust and adaptable templates for web apps or sites.

All technologies and files included in this project is authored to adhere to the Creative Jar Guidelines.

Features

• HTML5 ready. Use the new elements with confidence.
• Includes:
  • Creative Jar reset stylesheet
  • Folder structure and syntax conventions set out by Creative Jar Guidelines
  • jQuery
  • RequireJS
  • Hologram

Quick start

To get started with this boilerplate, choose one of the following options:

1. Download the latest stable release.
2. Clone the git repo — git clone https://github.com/creativejar/boilerplate.git

Things to remember

When getting started with your Boilerplate, it is important to remember the following things:

• Install any necessary gem files using bundler (bundler install)
• Install any necessary node modules using npm (npm install)
• Update your page <title> appropriately
• Update the colour palette and logo of your styleguide to match the client's branding
• If your project requires JavaScript, uncomment the default RequireJS code in Global.js to get started
• Make sure that the jQuery version included in the release is the latest available