README
Neue
This is Neue, our interface framework and pattern library. It defines a set of base styles and common patterns shared throughout our website. It's a strong foundation for building beautiful interfaces.
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, or read more about why we open-source our code.
Usage
You can get your own copy of Neue by downloading a release or by using NPM:
npm install dosomething-neue
Include the bundled dist/neue.css
and dist/neue.js
in your page. Be sure to include jQuery 1.7+ and the bundled Modernizr build dist/modernizr.js
. That's it! Check out the online pattern library and start building.
Neue supports Chrome 39+, Firefox 34+, Safari 7+, Android 4+, iOS 7+, and Internet Explorer 8+ (with polyfills). For IE 8 support, you'll need to include HTML5Shiv and Respond.js.
Local Development
You can also run the pattern library on your local machine! Here's the steps:
- Fork & clone this repository.
- Run
npm install
to configure dependencies. - Run
grunt
to build assets, watch for changes, and run styleguide server. - Check it out at
localhost:3000
in your browser!
License
©2015 DoSomething.org. Neue is free software, and may be redistributed under the terms specified in the LICENSE file. The name and logo for DoSomething.org are trademarks of Do Something, Inc and may not be used without permission.