Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.44 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.44 KB
Raw

🐢 Shelly, a simple Brunch Application shell.

Shelly is a Brunch App shell with some neat out of the box features. Made for web developers that want to move beyond vanilla HTML and CSS, and to help people write better and more scalable code. Some of Shelly's features:

This site is built with Brunch.js, Pug, SCSS, and JQuery. Follow these steps to get it running on your own computer:

Installation

Clone 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: make

  • Run:

    • make server — watches the project with continuous rebuild. This will also launch HTTP server with pushState.

  • Learn:

    • public/ dir is fully auto-generated and served by HTTP server. Write your code in app/ dir. To create the publi/ dir, type make build.
    • Place static files you want to be copied from app/assets/ to public/.
    • Brunch site, Getting started guide

Shelly

ES-next

To use proposed JS features not included into ES6, do this:

  • npm install --save-dev babel-preset-stage-0
  • in brunch-config.js, add the preset: presets: ['latest', 'stage-0']