https://github.com/foundation/foundation-zurb-template
Official ZURB Template for Foundation for Sites.
https://github.com/foundation/foundation-zurb-template
Last synced: 11 months ago
JSON representation
Official ZURB Template for Foundation for Sites.
- Host: GitHub
- URL: https://github.com/foundation/foundation-zurb-template
- Owner: foundation
- Created: 2015-05-19T22:12:45.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2024-09-27T21:02:06.000Z (almost 2 years ago)
- Last Synced: 2025-08-09T06:36:10.208Z (11 months ago)
- Language: SCSS
- Homepage:
- Size: 1.49 MB
- Stars: 327
- Watchers: 71
- Forks: 162
- Open Issues: 7
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# ZURB Template
**Please open all issues with this template on the main [Foundation for Sites](https://github.com/foundation/foundation-sites/issues) repo.**
This is the official ZURB Template for use with [Foundation for Sites](https://get.foundation/sites/docs/). 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 12 or greater recommended)
- [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/foundation/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`.