/frontend-skeleton

A basic static template skeleton built on HTML5 Boilerplate and Twitter Bootstrap, utilizing the power of Sass and Compass.

Primary LanguageJavaScript

Front-end Skeleton

A collection of resources to have the perfect (for me) starting point for front-end development projects.

Starring

Getting Started

Clone the repo get clone git@github.com:jonfaustman/front-end-skeleton.git or download the latest release.

Replace UA-XXXXX-X with your Google Analytics tracking ID, or delete the Google Analytics snippet from SKELETON.js.

Search the project for SKELETON and change it to your project/app's name. You can of course skip this step if you prefer.

Quick Start

If you're not using Sass (what's wrong with you?), you can remove the src directory (or not) and edit SKELETON.css directly. You can add <link rel="stylesheet" href="static/css/bootstrap/responsive.css"> after SKELETON.css if you want to use Twitter Bootstrap's responsive styles.

If you want to use Sass, but happen to not have Sass or Compass installed, you'll want to do that.

Sass

gem install sass

Compass

gem install compass

After Sass and Compass are up and running, feel free to edit the Sass files as you see fit. I prefer to keep all the project/application styles in a single file (SKELETON.sass) but also include imports/variables/mixins, etc. in _base.sass in case there is a need to create additional Sass files throughout.

Customize the Twitter Bootstrap Sass files to meet your project's needs. Be aware that this can complicate upgrading Twitter Bootstrap.

Markup and included files

Edit the markup to fit your needs, it's only meant to help get you started.

Twitter Bootstrap's JavaScript files are included in static/js/bootstrap/ - as they're needed, add them below the scripts towards the end of body.

License

MIT License

Major Components:

  • HTML5 Boilerplate: MIT License
  • Modernizr: MIT License
  • Twitter Bootstrap: Apache License, Version 2.0
  • Compass: modified MIT License
  • jQuery: MIT License