Skip to content

Latest commit

 

History

History
18 lines (13 loc) · 1.14 KB

CONTRIBUTING.md

File metadata and controls

18 lines (13 loc) · 1.14 KB

Contributing

Neue was built for our internal needs at DoSomething.org, but it could also work for your organization. Feel free to fork this repository and use it as a starting point for your own website and style guide.

The latest version of the pattern library is always available online at neue.dosomething.org.

Getting Started

You can also run the pattern library on your local machine! Here's the steps:

  1. Clone this repository.
  2. Run bower install, bundle install, and npm install to configure dependencies. Yikes.
  3. Run grunt to build CSS and JS from source (and watch for changes).
  4. Run rackup to start the server (or just link to Pow).
  5. Check it out in your browser!

Check the Deployment page on the wiki for instructions to deploy a new version of the Pattern Library.

Code Guidelines

Code guidelines for SCSS and JavaScript can be found as a README within their respective directories in the repo. We also use SCSS-Lint and JSHint to keep our code neat and tidy.