Skip to content
This repository

INIT extends HTML5 Boilerplate, adds more structure for SCSS and JavaScripts files, includes build tasks and a whole lot more.

branch: master

Docs: Make minor corrections in `usage.md`

Close #107 and #108.
latest commit 6c62e1d7c6
Melros Melros authored alrra committed
Octocat-spinner-32 docs Docs: Make minor corrections in `usage.md` April 11, 2014
Octocat-spinner-32 grunt Add config option to add custom concat tasks (#87) March 25, 2014
Octocat-spinner-32 img Add HTML5 Boilerplate current draft June 16, 2012
Octocat-spinner-32 js Fix path of jQuery in config.js which changed with v1.11.0 February 25, 2014
Octocat-spinner-32 scss Minor updates of IE 6, 7 support December 25, 2013
Octocat-spinner-32 templates Simplify templates markup (closes #81) December 30, 2013
Octocat-spinner-32 test Add another test for the test module November 19, 2013
Octocat-spinner-32 .bowerrc Add .bowerrc configuration file for Bower August 18, 2013
Octocat-spinner-32 .editorconfig Update `.editorconfig` February 20, 2014
Octocat-spinner-32 .gitattributes Add ignores, htaccess June 16, 2012
Octocat-spinner-32 .gitignore Add about.html (example template file) to gitignore December 29, 2013
Octocat-spinner-32 .htaccess Update to Apache Server Configs v2.3.0 April 10, 2014
Octocat-spinner-32 .jshintrc Add relaxing option "eqnull" to JSHint config file. December 30, 2013
Octocat-spinner-32 .travis.yml Add caching directory to node_modules December 06, 2013
Octocat-spinner-32 404.html Update 404 to reduce uncopressed size January 11, 2014
Octocat-spinner-32 AUTHORS Add Catalin to authors January 29, 2014
Octocat-spinner-32 CHANGELOG.md Update to Apache Server Configs v2.3.0 April 10, 2014
Octocat-spinner-32 CONTRIBUTING.md Update links to new repository December 13, 2013
Octocat-spinner-32 Gruntfile.js Use load-grunt-tasks instead of matchdep March 25, 2014
Octocat-spinner-32 LICENSE.md Update year license.md January 29, 2014
Octocat-spinner-32 README.md Minor updates to README file March 25, 2014
Octocat-spinner-32 apple-touch-icon-precomposed.png Use INIT logo for tiles and icons March 30, 2014
Octocat-spinner-32 bower.json v1.2.0 April 02, 2014
Octocat-spinner-32 browserconfig.xml Add `/browserconfig.xml` and tile images March 04, 2014
Octocat-spinner-32 crossdomain.xml Add HTML5 Boilerplate current draft June 16, 2012
Octocat-spinner-32 favicon.ico Use INIT logo for tiles and icons March 30, 2014
Octocat-spinner-32 humans.txt Update license with current year, reflect normalize.css in humans.txt January 21, 2013
Octocat-spinner-32 logo.svg Optimize SVG logo September 30, 2013
Octocat-spinner-32 package.json v1.2.0 April 02, 2014
Octocat-spinner-32 pages.json Consistently use about as 2nd page December 30, 2013
Octocat-spinner-32 robots.txt Add `Disallow:` to `robots.txt` January 22, 2014
Octocat-spinner-32 tile-wide.png Optimize tile image "wide" March 30, 2014
Octocat-spinner-32 tile.png Use INIT logo for tiles and icons March 30, 2014
README.md

INIT

This project is based upon HTML5 Boilerplate and adds more structure for SCSS and JavaScript files, includes build tasks and a whole lot more.

Build Status Dependency Status devDependency Status Built with Grunt

Dependencies

You will need to install some stuff, if you haven't already:

Majors:

  • Node.js
  • Ruby

Secondaries:

  • Node: npm
  • Ruby: Sass 3.3.x

After you've set this stuff up please run

$ npm install -g grunt-cli bower

This installs the Grunt command line tools and bower. Afterwards please run

$ npm install

in your project's directory. This will install all the things you need for running the grunt-tasks automatically and all Bower components defined in bower.json.

Also it will create a folder components which holds all vendor dependencies managed by Bower.

Troubleshooting

If running the install does not work, please try running it as with admin-rights:

$ sudo npm install -g grunt-cli

Browser support

  • Chrome
  • Firefox 4+
  • Internet Explorer 8+
  • Opera 12+
  • Safari 5+

Yeoman Generator-INIT

INIT is also available as Yeoman Generator and is called generator-init. See the repository for detailed instruction and more information.

Contribute

Please help making this project better and contribute with your knowledge.

CSS

We are currently working with Sass (in its dialect SCSS) and do not use CSS directly. Please do not edit the CSS-files in any case but search the corresponding .scss file and edit it accordingly. If you are not familiar with SCSS you can write pure CSS which is actually valid SCSS.

However all .scss-files are compiled into one file called main.css in the css-folder. There is a productive-version (means minified), too.

You can find more information about the installation process of Sass and the usage of SCSS in the Sass Tutorial.

JS

We use jQuery, Modernizr (custom build via Grunt) and RequireJS.

Please use JSHint for your JavaScript before you commit. You can use the Grunt-task jshint for this. It is also integrated in grunt watch.

Creating a Build

Please use Grunt.js for building a production-state of a website. The Gruntfile.js has tasks for concatenating and minifing CSS and JavaScript.

Additional information on this project is stored in package.json.

Development

This package is developed and maintained by Hans Christian Reinl, Anselm Hannemann and more contributors.

Credits

The INIT logo was designed by Jan von Beckerath at NIMIUS and optimized by Stefan Nitzsche.

License

Please be aware of the licenses of each component we use in this project. Everything else that has been developed by the contributions to this project is under MIT License.

Bitdeli Badge

Something went wrong with that request. Please try again.