Getting started

Prerequisites

OMG, I'm ready

Functional overview

Style guides are currently installed via Bower.

Create a directory for your style
Create definition.json file in your brand spanking new directory that looks like this:

{
	"title": "Retro 1990's Style Guide",
	"elements": ["buttons", "typography", "icons", etc.],
  	"files": ["path/to/styles.scss"]
}

Create a directory for element in the style guide, e.g. buttons
In each directory create document.yml and style.scss files
- Your document.yml file should contain your elements' markup, example
- Your style.scss file is where you put your own styles for your element
In your root directory, create a style.scss to be built, which imports the styles for each element, e.g.
```
	@import 'typography/style';
  @import 'buttons/style';
  @import 'icons/style';
```
Publish it via bower (push to Github, and tag)
Install it into Preston, bower install --save my-groovy-style-guide
Raise a Pull Request to this repo with the updated bower.json

Take a look at outnet-2015 for an example of a style guide.

App runs from src directory
Style guides stored in src/styles/{project}/ via Bower.
Styles compiled by node-sass middleware at runtime
- App styles compiled to src/client/css/
- Style guides compiled to src/client/css/{guide-name}
Built on top of API
- API routes should be defined in src/routes/
- Try hitting /api/1.0/styles
Can deploy style guides to S3 via the build, but it's recommended that you set up your own deployment pipeline in your own style guide

Preston is hosted as a service on http://preston-nap.herokuapp.com.

This is continuously deployed to whenever changes are merged into to master.