75 lines
4.0 KiB
Markdown
75 lines
4.0 KiB
Markdown
<p align="center">
|
||
<a href="http://foundation.zurb.com/">
|
||
<img src="https://user-images.githubusercontent.com/9939075/38782856-2a64a43e-40fa-11e8-89cd-e873af03b3c4.png" alt="Foundation for Sites 6" width="448px" style="max-width:100%;"/>
|
||
</a>
|
||
</p>
|
||
|
||
|
||
|
||
|
||
<p align="center">
|
||
<a href="https://foundation.zurb.com/sites/docs/installation.html"><b>Install</b></a>
|
||
| <a href="https://foundation.zurb.com/sites/docs">Documentation</a>
|
||
| <a href="https://github.com/zurb/foundation-sites/releases">Releases</a>
|
||
| <a href="CONTRIBUTING.md">Contributing</a>
|
||
</p>
|
||
|
||
---
|
||
|
||
|
||
[](https://travis-ci.org/zurb/foundation-sites)
|
||
[](https://david-dm.org/zurb/foundation-sites)
|
||
[](https://david-dm.org/zurb/foundation-sites?type=dev)
|
||
[](https://badge.fury.io/js/foundation-sites)
|
||
[](https://badge.fury.io/bo/foundation-sites)
|
||
[](https://badge.fury.io/rb/foundation-rails)
|
||
[](https://www.jsdelivr.com/package/npm/foundation-sites)
|
||
[](https://gitter.im/zurb/foundation-sites?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||
|
||
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.
|
||
|
||
---
|
||
|
||
## Run locally
|
||
|
||
### Documentation
|
||
|
||
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 **6.4.0** or higher). Run these commands to set up the documentation:
|
||
|
||
```bash
|
||
# Install
|
||
git clone https://github.com/zurb/foundation-sites
|
||
cd foundation-sites
|
||
npm install
|
||
|
||
# Start the documentation
|
||
npm start
|
||
```
|
||
|
||
### Testing
|
||
|
||
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.
|
||
|
||
Run tests with:
|
||
```bash
|
||
# Sass unit tests
|
||
npm run test:sass
|
||
# JavaScript unit tests
|
||
npm run test:javascript:units
|
||
# Visual tests
|
||
npm run test:visual
|
||
```
|
||
|
||
Testing Supported By<br/>
|
||
<img width="160" src="http://foundation.zurb.com/sites/docs/assets/img/logos/browser-stack.svg" alt="BrowserStack"/>
|
||
|
||
## Contributing
|
||
|
||
Check out [CONTRIBUTING.md](CONTRIBUTING.md) to see how to report an issue or submit a bug fix or a new feature, and our [contributing guide](http://foundation.zurb.com/develop/contribute.html) to learn how you can contribute more globally 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.
|
||
|
||
## Training
|
||
|
||
Want the guided tour to Foundation from the team that built it? The ZURB team offers comprehensive training courses for developers of all skill levels. If you're new to Foundation, check out the [Introduction to Foundation Course](http://zurb.com/university/foundation-intro?utm_source=Github%20Repo&utm_medium=website&utm_campaign=readme&utm_content=readme%20training%20link) to kickstart your skills, amplify your productivity, and get a comprehensive overview of everything Foundation has to offer. More advanced users should check out the [Advanced Foundation Course](http://zurb.com/university/advanced-foundation-training?utm_source=Github%20Repo&utm_medium=website&utm_campaign=readme&utm_content=readme%20training%20link) to learn the Advanced skills that ZURB uses to deliver quality client work in short timeframes.
|
||
|
||
Copyright (c) 2018 ZURB, Inc.
|