README.md

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 npm package.

Release Steps

The publish script will build, tag, and publish to NPM for use across VHX applications.

1. Squash and Merge PR
2. Checkout Master branch locally and pull latest
3. Update VERSION (using Semantic Versioning) - package.json versioning is handled by the publish script based on this VERSION file
4. Update CHANGELOG (add new entry using VERSION's number, the date, and description from PR)
5. Don't commit as this will be part of the publish script (adds a tag with your commit)
6. Check that you're logged in with npm whoami and that you have Quartz npm package permissions https://www.npmjs.com/package/@vhx/quartz
7. Run ./publish

Using in your Application

First install via NPM.

npm install @vhx/quartz

Then include Quartz files as needed.

Include all of Quartz core (in SASS or LESS). This does not include icons.

@import '~@vhx/quartz/dist/quartz.css';

// minified
@import '~@vhx/quartz/dist/quartz.min.css';

Or include individual features and icons (in SASS or LESS).

@import '~@vhx/quartz/dist/grid.css';
@import '~@vhx/quartz/dist/icon-code.css';