Quartz

Style guide & elements + asset build pipeline for VHX.

Getting Started

Note: Currently for VHX internal use.

Initial Setup

1. Clone the repo
2. Run ./setup
3. Done.

Starting the server

1. Run ./server
2. Go to: http://quartz.dev

Build and Release

Note: Currently for VHX internal use. You will need permissions to push changes to the quartz repo (VHX team members) and the quartz-rails rubygem repo. Create an account at https://rubygems.org/ and then let [email protected] know.

Release Steps

The build and release script will release both the vhx-quartz gem and vhx-quartz bower packages for use across VHX applications.

1. Squash and Merge PR
2. Checkout Master branch locally
3. Update VERSION (using Semantic Versioning)
4. Update CHANGELOG (add new entry using VERSION's number, the date, and description from PR)
5. Run ./build

Using in your Application

You can use Quartz either through the Ruby Gem or Bower package.

Via the Ruby Gem

1. Add the VHX Quartz to your Gemfile

gem 'vhx-quartz'

2. Then install the gem either via

bundle install

or directly with

gem install vhx-quartz

3. Then include in your layout or SASS files

   a. In your Layout

   Add the following to your config.rb file

   sprockets.import_asset 'vhx-quartz.css'

   Then include in your layout directly

   <%= stylesheet_link_tag  'vhx-quartz' %>

   b. Or in your SASS files

   At the top of your file, either via the asset pipeline

   //= require vhx-quartz

   Or via a SASS import

   @import "vhx-quartz"

Via the Bower Package

1. Install Bower via npm if you don't already have it installed

   npm install -g bower

2. Add the VHX Quartz package to your repo

   bower install vhx-quartz