Inflame is a boilerplate for web projects that allows you to get up and running quickly, including build tasks, automation, and more.
ApacheConf JavaScript HTML CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
favicons.ico
images
js
sass
.editorconfig
.gitattributes
.gitignore
.htaccess
.jshintrc
.travis.yml
404.html
LICENSE.md
README.md
bower.json
gruntfile.js
humans.txt
index.html
package.json
robots.txt

README.md

Inflame

Join the chat at https://gitter.im/derek-skinner/Inflame

This project is meant to be used as a starting boilerplate to your web projects. Includes folder structures, Favicons. task automation, grunt plugins, and more.

Dependency Status devDependency Status Built with Grunt Code Climate

Dependencies

If you don't already have the following installed, you will need to install these first:

  • Node.js
  • npm
  • Ruby
  • Sass

After you've set this stuff up please run

$ npm install -g grunt-cli bower

This installs the Grunt command line tools and bower. Then CD into your directory of choice and run:

$ npm install

This will install all the things you need for running the grunt-tasks automatically. Then install the Bower components using:

$ bower install

That command will create a folder Bower_Components which holds all vendor dependencies managed by Bower that are listed in the bower.json file.

Troubleshooting

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

$ sudo npm install -g grunt-cli

$ sudo npm install

Browser support

sudo * Chrome

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

Contribute

Feel free to contribute and help this project grow! Any support and/or feedback is always welcome.

CSS

Inflame was built with the idea that your project will be using Sass. 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.

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

If you need help installing Sass on your Windows machine, you can follow this great tutorial: Sass Tutorial - Windows

JS

Currently in use is jQuery, Modernizr and RequireJS.

Please use JSHint for your JavaScript before you commit. You can use the Grunt-task jshint for this. You can also just run 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 project is developed and maintained by Derek Skinner

Credits

Ricardo Zea - Windows Sass Tutorial for beginners

Credits will be added here as needed.

License

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