Code Monkey home page Code Monkey logo

pistachio's Introduction

Pistachio Travis

The graze front end framework and style guide.

Versioned Releases

Pistachio is available on the CloudFront CDN, with CORS support enabled.

View Versioned Releases.

CSS

Development Release

A development release is available, uncached, and redeployed on every push to the master branch. Not recommended for use in live websites, use the latest versioned release instead.

<link href="https://pistachio-cdn.graze.com/dev/css/pistachio.css" rel="stylesheet">

Modular CSS

For versioned releases of modules modify the url like so: https://pistachio-cdn.graze.com/<version>/css/<module>.css

Core CSS only

Optional Modules

JavaScript

Development Release

A development release is available, uncached, and redeployed on every push to the master branch. Not recommended for use in live websites, use the latest versioned release instead.

<script src="https://pistachio-cdn.graze.com/dev/js/pistachio.js"></script>

Dependencies

Requires Jquery which can be loaded via CDN or locally.

<script src="https://code.jquery.com/jquery-2.1.4.min.js"></script>

Development

Getting Started

~$ git clone https://github.com/graze/pistachio.git
~$ npm install -g gulp
~$ cd pistachio

Local Style Guide

To view the style guide locally:

~$ npm install
~$ gulp build
~$ npm start

Docs should now be visible on http://localhost:4000/.

Make sure to regularly run npm update to keep your dependencies up to date.

The style guide is a simple express app. More information about the express app can be found in the site README.

LESS Compilation

To watch LESS for changes and recompile the CSS:

~$ gulp dev

JavaScript Compilation

To compile the JavaScript:

~$ gulp build:js

Deploying

The projects documentation and style guide is deployed to Heroku on every push to the master branch and is visible at http://pistachio.graze.com/.

In order to release you'll need npm@^3.0, you can get the latest by running npm install -g npm@latest.

Follow these simple steps to deploy a versioned release:

  1. Run npm version -m ":rocket: Release %s." on the master branch with a semver as it's argument (e.g. npm version -m ":rocket: Release %s." 1.0.0)
  2. A new release/ branch, and tag, will be published to GitHub, open a PR to merge the branch into master
  3. The Travis CI build for the tag will publish the resources to s3 and trigger Heroku to deploy the style guide
  4. Update the release notes on GitHub, not forgetting the html snippets printed out in the build

pistachio's People

Contributors

leejordan avatar notlee avatar iamstuartwilson avatar sjparkinson avatar jakewright avatar

Watchers

James Cloos avatar Ismail Mechbal avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.