|
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970 |
- # ZURB Template
-
- [![devDependency Status](https://david-dm.org/zurb/foundation-zurb-template/dev-status.svg)](https://david-dm.org/zurb/foundation-zurb-template#info=devDependencies)
-
- **Please open all issues with this template on the main [Foundation for Sites](https://github.com/zurb/foundation-sites/issues) repo.**
-
- This is the official ZURB Template for use with [Foundation for Sites](http://foundation.zurb.com/sites). We use this template at ZURB to deliver static code to our clients. It has a Gulp-powered build system with these features:
-
- - Handlebars HTML templates with Panini
- - Sass compilation and prefixing
- - JavaScript module bundling with webpack
- - Built-in BrowserSync server
- - For production builds:
- - CSS compression
- - JavaScript module bundling with webpack
- - Image compression
-
- ## Installation
-
- To use this template, your computer needs:
-
- - [NodeJS](https://nodejs.org/en/) (Version 6 or greater recommended, tested with 6.11.4 and 8.12.0)
- - [Git](https://git-scm.com/)
-
- This template can be installed with the Foundation CLI, or downloaded and set up manually.
-
- ### Using the CLI
-
- Install the Foundation CLI with this command:
-
- ```bash
- npm install foundation-cli --global
- ```
-
- Use this command to set up a blank Foundation for Sites project with this template:
-
- ```bash
- foundation new --framework sites --template zurb
- ```
-
- The CLI will prompt you to give your project a name. The template will be downloaded into a folder with this name.
-
- Now `cd` to your project name and to start your project run
-
- ```bash
- foundation watch
- ```
-
- ### Manual Setup
-
- To manually set up the template, first download it with Git:
-
- ```bash
- git clone https://github.com/zurb/foundation-zurb-template projectname
- ```
-
- Then open the folder in your command line, and install the needed dependencies:
-
- ```bash
- cd projectname
- yarn
- ```
-
- Finally, run `yarn start` to run Gulp. Your finished site will be created in a folder called `dist`, viewable at this URL:
-
- ```
- http://localhost:8000
- ```
-
- To create compressed, production-ready assets, run `yarn run build`.
|