Skip to content

🍽 Skeleton for Brunch for a long-scroll, single, static Web page

License

Notifications You must be signed in to change notification settings

jfilter/brunch-on-speed

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

22 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Brunch on Speed

This is a skeleton (or boilerplate) for Brunch, a fast and easy to configure building tool for modern Web development. The skeleton is intended to be a foundation for a long-scroll, single, static Web page.

dependencies Status devDependency Status

Installation

Clone this repo manually or use brunch new DIRECTORY -s jfilter/brunch-on-speed

Features

Recommendation

To complete the development environment, make sure to integrate ESLint and Prettier into your text editor.

Getting started with Brunch

  • 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
  • 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:
    • 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/.
    • Brunch site, Getting started guide