Giter Club home page Giter Club logo

daisy's Introduction

daisy

This is a vagrant and grunt powered Pattern Lab, an Atomic Web Design Design Pattern library/styleguide, derivative work from hbr.org's 2014 redesign. We use SCSS version of Foundation which is installed via bower.

Read about it here: http://hbrgtech.github.io/pattern-lab-team-workflow/ and Daigo's blog post

Published results can be viewed at http://daisy.pattern.lab/ (or your local domain of choice) after vagrant is up.

Edit your scss in the www/source/scss folder and your html/mustache mark-up in the www/source/_patterns folder. Pattern Lab will automatically be generated to http://daisy.pattern.lab/pattern-lab if grunt watch is running properly (if it isn't, use vagrant ssh, cd /vagrant_data, and run grunt or grunt watch manually).

Pattern-Lab documentation:

Versions included (Updated as of November, 2014):

  • Foundation v5.4.7 (see bower.json)
  • Pattern-lab v0.7.12

Daisy

Overview

Included within this project is a Vagrant development environment. The goal is provide you with an environment that can be cloned to allow multiple front-end developers to quickly collaborate.

What You Get

  • Ubuntu 14.04
  • Apache
  • PHP CLI
  • Ruby
  • Node.js/npm
  • Grunt
  • Pattern Lab
  • Zurb Foundation See package.json and bower.json for version information.

Requirements

Getting Started

Download Vagrant and VirtualBox. After cloning this repository to your computer, you'll want to start up the vagrant box by following the instructions below. The first time you run the installer will be the slowest, as it will download the Virtual Box image and provision the Virtual Machine. Each subsequent run will ensure that the Virtual Machine has the lastest tools and code available.

Unix/Mac

If you are on a Unix based machine or an OSX based Mac, the setup is pretty easy.

  1. Clone the daisy Github repo
  2. Also clone all submodules by running git submodule update —init
  3. Open a terminal and run the init script: ./bin/daisy-init.sh
  4. If you get 'permission denied' run 'chmod 755 ./bin/daisy-init.sh'
  5. Go to http://daisy.pattern.lab in a web browser on the computer running vagrant.

Windows

Daisy is only supported on Windows 7 and above. If you are using Windows XP, please ensure that you have the Windows Power Shell installed.

  1. Clone the daisy Github repo
  2. Also clone all submodules by running git submodule update —init
  3. Run the installer batch script: ./bin/daisy-init.bat
  4. Go to http://daisy.pattern.lab/ in a web browser on the computer running vagrant (may launch automatically).

Vagrant Primer

The Vagrant CLI documentation will be useful for developers that haven't used Vagrant before. Since Daisy is built on top of Vagrant, the Vagrant CLI commands will also work.

Some useful commands:

  • vagrant up - Start and provisions the VM
  • vagrant ssh - Logs into the VM with ssh
  • vagrant reload - Restarts and provisions the VM
  • vagrant provision - Provisions the VM. You can also do vagrant up --provsison or vagrant reload --provision
  • vagrant suspend and vagrat resume - If you don't want fully shut it down
  • vagrant halt - Stops the VM
  • vagrant destroy - Deletes the VM

Working with the respository and the VM

Once the VM is up and running, any changes made to the /source/www/resources/ will be automatically compilied. To see the output of these changes, check grunt.log.

If for some reason, you suspect grunt is not running (i.e. grunt.log does not update, css does not compile, or pattern lab not generated) you can go into the VM by vagrant ssh then cd /vagrant_data. There, you can see if grunt is on, ps aux | grep grunt. If you see a process, you can stop it by kill [process id]. If you do not see grunt in process, you can either run bin/watch.sh or grunt watch.

For more information on grunt, read this excellent tutorial by Chris Coyer titled "Grunt for People Who Think Things Like Grunt are Weird and Hard"

daisy's People

Contributors

daigofuji avatar flagster76 avatar

Stargazers

 avatar

Watchers

 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.