Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mathieutu/facilitio-website

Last synced: about 19 hours ago
JSON representation

Host: GitHub
URL: https://github.com/mathieutu/facilitio-website
Owner: mathieutu
Created: 2020-12-30T10:02:25.000Z (almost 4 years ago)
Default Branch: master
Last Pushed: 2020-12-30T10:02:59.000Z (almost 4 years ago)
Last Synced: 2024-11-05T16:58:00.654Z (about 2 months ago)
Language: SCSS
Size: 17.4 MB
Stars: 0
Watchers: 3
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md
- Changelog: CHANGELOG.md

Awesome Lists containing this project

README

# 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 compression
- Image compression

## Installation

To use this template, your computer needs:

- [NodeJS](https://nodejs.org/en/) (0.12 or greater)
- [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
npm install
```

Finally, run `npm 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 `npm run build`.

## Deploy on Heroku

Heroku now has a static buildpack in development to handle this (see https://github.com/heroku/heroku-buildpack-static)
Create a `static.json` file to use the files from dist/ with .html suffix and to re-route all calls back to the SPA

```json
{
"root": "dist/",
"clean_urls": true,
"routes": {
"/**": "index.html"
}
}
```

Extend package.json scripts to ensure dist/ directory is built, for example
```json
{
"scripts": {
"postinstall": "npm run build"
}
}
```

So that dev dependencies from package.json get installed
```bash
heroku config:set NPM_CONFIG_PRODUCTION=false
```

Multiple build packs so you can build and deploy

```bash
heroku buildpacks:add heroku/nodejs
heroku buildpacks:add https://github.com/heroku/heroku-buildpack-static.git
```

Your procfile can be empty in this case.