cubicon-feup/website

cubicon's website repository

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.

Installation

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

Features

• Twitter Bootstrap v3
• jQuery
• Compilation of ECMAScript 2015 (ECMAScript 6) files with Babel
• Uglification and concatenation of Javascript files with UglifyJS
• Extending CSS with Sass
• Autoprefixing, concatenation, minification (and more) of CSS files with Pleeease (PostCSS)
• Auto reload of development server
• ESLint with AirBnB Javascript Style Guide
• Ready to format your code with Prettier
• index.html with essential meta tags for SEO and Social Media

Recommendation

To complete the development environment, I suggest the use of code linters in your favorite text editor. For Sublime Text, I can recommend the following: ESLint, Sass and HTML.

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