History

samuel-p df74a5bd41 Initial commit		2016-10-28 19:56:41 +02:00
..
.github	Initial commit	2016-10-28 19:56:41 +02:00
assets	Initial commit	2016-10-28 19:56:41 +02:00
customizer	Initial commit	2016-10-28 19:56:41 +02:00
dist	Initial commit	2016-10-28 19:56:41 +02:00
js	Initial commit	2016-10-28 19:56:41 +02:00
scss	Initial commit	2016-10-28 19:56:41 +02:00
.bower.json	Initial commit	2016-10-28 19:56:41 +02:00
.bowerrc	Initial commit	2016-10-28 19:56:41 +02:00
.eslintrc	Initial commit	2016-10-28 19:56:41 +02:00
.scss-lint.yml	Initial commit	2016-10-28 19:56:41 +02:00
.travis.yml	Initial commit	2016-10-28 19:56:41 +02:00
bower.json	Initial commit	2016-10-28 19:56:41 +02:00
code-of-conduct.md	Initial commit	2016-10-28 19:56:41 +02:00
docslink.sh	Initial commit	2016-10-28 19:56:41 +02:00
LICENSE	Initial commit	2016-10-28 19:56:41 +02:00
README.md	Initial commit	2016-10-28 19:56:41 +02:00

README.md

Foundation for Sites

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.

Getting Started

The quickest way to get started is with the basic CSS download. You can get versions with every component, essential ones only, or a custom build.

If you're a Sass user, we have two starter project templates, the Basic Template and the ZURB Template. You can install them by manually downloading them from GitHub, or using the Foundation CLI.

Lastly, if you're rolling your own setup, you can install Foundation through a variety of package managers.

Documentation

The documentation can be found at https://foundation.zurb.com/sites/docs. To run the documentation locally on your machine, you need Node.js and Ruby installed on your computer. (Your Node.js version must be 0.12 or higher.)

Run these commands to set up the documentation:

git clone https://github.com/zurb/foundation-sites
cd foundation-sites
gem install scss-lint
npm install

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.

Testing

Foundation has three kinds of tests: JavaScript, Sass, and visual regression. Refer to our testing guide for more details.

These commands will run the various tests:

npm run test:sass
npm run test:javascript
npm run test:visual

Contributing

Check out our contributing guide to learn how you can contribute to Foundation. You can also browse the Help Wanted tag in our issue tracker to find things to do.