Skip to content

Latest commit

 

History

History
69 lines (50 loc) · 2.27 KB

README.md

File metadata and controls

69 lines (50 loc) · 2.27 KB
Raw

Foundation 6 Boilerplate

Foundation 6.4 and FontAwesome 4.7 Boilerplate, bundled with Webpack and managed by Laravel Mix.

Introduction

Foundation Boilerplate comes with Foundation 6.4 framework, FontAwesome icons pack and makes use of Laravel Mix for defining basic Webpack build steps for your application.

Foundation Boilerplate is preconfigured to perform these Mix tasks:

  • Sass compilation with URL rewriting and Autoprefixer PostCSS plugin
  • JavaScript bundling with ES5 code compilation
  • Vendor libraries extraction, for improved long-term caching
  • In-file source maps generation
  • Browser synchronization on changes
  • Minification on production

Requirements

This project requires Node.js to be installed on your machine. Run node -v on your shell to check if you are ready. Your Node.js version must be 4.0 or higher.

Quick Start

These instructions will get you a copy of Foundation Boilerplate up and running on your local machine.

1. Install

Clone the repository and install with npm:

git clone https://github.com/CarloBernardi/foundation-boilerplate.git
cd foundation-boilerplate
npm install

2. Configure

Open webpack.mix.js file and edit these constants as you prefer:

// Path to dist folder
const DIST = 'dist';

// Proxy an existing virtual host (eg: 'boilerplate.dev', 'localhost/foundation-boilerplate').
// If null, use the built-in static server.
const PROXY = null;

3. Get Started

Mix is a configuration layer on top of Webpack, so to run your Mix tasks you only need to execute one of the NPM scripts that is included with the default package.json file.

Run all Mix tasks

npm run dev

Watch assets for changes and Sync browser

npm run watch

Run all Mix tasks and minify output

npm run production

Documentation

License

This project is licensed under the MIT License - see the LICENSE file for details.