Skip to content

vdcrea/brunch-boilerplate

Repository files navigation

Brunch + Babel/ES6 Boilerplate

This is a modern JS skeleton for Brunch.

Installation

Download this repo.

Getting started

  • Install (if you don't have them):
    • Node.js: brew install node on OS X
    • Brunch: npm install -g brunch
    • Brunch plugins and app dependencies: npm install if you have error and using npm@5, downgrade to npm@4, if you still have errors, try sudo npm install
  • Design:
    • Cut out your mockup in files and put it in artworks dir.
    • npm run prep — prepares all components needed in src/components/ and generate src/main.js with all components js.
    • if you delete the js file of a component, re-run npm run prep to regenerate the correct src/main.js file.
  • Run:
    • npm start — watches the project with continuous rebuild. This will also launch HTTP server with pushState.
    • npm run build — builds minified project for production
  • Learn:
    • www/src/ dir is fully auto-generated and served by HTTP server. Write your code in src/ dir.
    • Place static files you want to be copied from src/assets/ to www/src/assets/.
    • Brunch site, Getting started guide

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published