| 1 | # [Foundation for Sites](http://foundation.zurb.com)
|
| 2 |
|
| 3 | [](https://travis-ci.org/zurb/foundation-sites)
|
| 4 | [](https://badge.fury.io/js/foundation-sites)
|
| 5 | [](https://badge.fury.io/bo/foundation-sites)
|
| 6 | [](https://badge.fury.io/rb/foundation-rails)
|
| 7 | [](https://cdnjs.com/libraries/foundation)
|
| 8 | [](https://david-dm.org/zurb/foundation-sites)
|
| 9 | [](https://david-dm.org/zurb/foundation-sites?type=dev)
|
| 10 | [](https://gitter.im/zurb/foundation-sites?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
| 11 |
|
| 12 | Foundation is the most advanced responsive front-end framework in the world. Quickly go from prototype to production, building sites or apps that work on any kind of device with Foundation. Includes a fully customizable, responsive grid, a large library of Sass mixins, commonly used JavaScript plugins, and full accessibility support.
|
| 13 |
|
| 14 | ## Getting Started
|
| 15 |
|
| 16 | The quickest way to get started is with the [basic CSS download](http://foundation.zurb.com/sites/download/). You can get versions with every component, essential ones only, or a custom build.
|
| 17 |
|
| 18 | If you're a Sass user, we have two starter project templates, the [Basic Template](https://github.com/zurb/foundation-sites-template) and the [ZURB Template](https://github.com/zurb/foundation-zurb-template). You can install them by manually downloading them from GitHub, or using the [Foundation CLI](https://github.com/zurb/foundation-cli).
|
| 19 |
|
| 20 | Lastly, if you're rolling your own setup, you can install Foundation through a variety of [package managers](http://foundation.zurb.com/sites/docs/installation.html#package-managers).
|
| 21 |
|
| 22 | ## Documentation
|
| 23 |
|
| 24 | The documentation can be found at <https://foundation.zurb.com/sites/docs>. To run the documentation locally on your machine, you need [Node.js](https://nodejs.org/en/) installed on your computer. (Your Node.js version must be **4.0** or higher.)
|
| 25 |
|
| 26 | Run these commands to set up the documentation:
|
| 27 |
|
| 28 | ```bash
|
| 29 | git clone https://github.com/zurb/foundation-sites
|
| 30 | cd foundation-sites
|
| 31 | npm install
|
| 32 | ```
|
| 33 |
|
| 34 | Then run `npm start` to compile the documentation. When it finishes, a new browser window will open pointing to a BrowserSync server displaying the documentation.
|
| 35 |
|
| 36 | ## Testing
|
| 37 |
|
| 38 | Foundation has three kinds of tests: JavaScript, Sass, and visual regression. Refer to our [testing guide](https://github.com/zurb/foundation-sites/wiki/Testing-Guide) for more details.
|
| 39 |
|
| 40 | These commands will run the various tests:
|
| 41 |
|
| 42 | - `npm run test:sass`
|
| 43 | - `npm run test:javascript:phantomjs`
|
| 44 | - `npm run test:visual`
|
| 45 |
|
| 46 | Testing Supported By<br/>
|
| 47 | <img width="160" src="http://foundation.zurb.com/sites/docs/assets/img/logos/browser-stack.svg" alt="BrowserStack"/>
|
| 48 |
|
| 49 | ## Contributing
|
| 50 |
|
| 51 | Check out our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute to Foundation. You can also browse the [Help Wanted](https://github.com/zurb/foundation-sites/labels/help%20wanted) tag in our issue tracker to find things to do.
|
| 52 |
|
| 53 | Copyright (c) 2017 ZURB, inc.
|