Skip to content
This repository has been archived by the owner on Oct 6, 2022. It is now read-only.

hyyan/brunch-with-hyyan

Repository files navigation

Brunch With Bower , Bootstrap Sass And jQuery

project status dependency Status MIT licensed

HTML5 application, built with Brunch, Bootstrap Sass And jQuery

Getting started

  • Install (if you don't have them):
    • Node.js: brew install node on OS X
    • Brunch: npm install -g brunch
    • Bower: npm install -g bower
    • Brunch plugins and Bower dependencies: npm install.
  • Run:
    • npm start — watches the project with continuous rebuild. This will also launch HTTP server with pushState.
    • npm test - Run you tests inside test folder using karam and mocha
    • brunch watch --server — watches the project with continuous rebuild. This will also launch HTTP server with pushState.
    • brunch build --production — builds minified project for production
  • Learn:
    • public/ dir is fully auto-generated and served by HTTP server. Write your code in app/ dir.
    • Place static files you want to be copied from app/assets/ to public/.
    • Place styles in app/scss/styles to be compiled to public/css/app.css
    • Place styles in app/scss/styles-rtl to be compiled to public/css/app-rtl.css
    • Place styles in app/scss/editor to be compiled to public/css/editor.css
    • Place styles in app/scss/editor-rtl to be compiled to public/css/editor-rtl.css
    • Place javascripts in app/scripts to be concatenated to public/js/app.js
    • Brunch site
    • Sass site
    • Bootstrap site

How To Use With Wordpress

You can use the Brunch Wordpress Theme starter theme , which make use of all features of this skeleton in wordpress context.