Why INIT?
INIT aims to provide you with a decent workflow and structure within your sophisticated web project. Please go through @drublic's slides from SoCoded Conference talking about the hassle to start Front-End web projects.
Here are some advantages you have with INIT:
- All basics provided
- Nearly no default code (only what you will need anyway)
- Scalable architecture
- Works with most UI frameworks
- Integrated workflow
Integrated tools
- HTML5 Boilerplate
- normalize.css
- Modernizr (custom build based on what you use) & jQuery libraries
- GruntJS (integrated watch, development & build tasks)
- Bower for package management in the Front-End
- RequireJS for a module-based development approach
- Sass workflow including some helpful mixins
- A testing workflow with Jasmine and Karma
If you want to know more about INIT please check out the documentation.
Getting Started
The easiest way to set up INIT*:
$ git clone git@github.com:use-init/init.git
$ npm install -g grunt-cli
$ npm install
This will install all the things you need for running the grunt-tasks automatically.
Also it will create a folder `components` which holds all vendor dependencies managed by Bower.
*You need to have a running node.js and ruby along with npm, Sass and bower. Please install this before setting up INIT in your project's directory.
Troubleshooting
If running the install does not work, please try running it as with admin-rights:
$ sudo npm install -g grunt-cli
Now you can start developing your site. Therefore use the GruntJS task:
$ grunt
or run grunt tasks continuously watching file changes:
$ grunt watch
Structure
INIT's structure isn’t hard to understand. Please refer to the documentation to get to know the details.
INIT builds upon the best
INIT is extendable
It is easy to extend and adapt INIT to your needs. There are already some core plugins available as well as a Yeoman Generator called generator-init
.
Credits
The INIT logo was designed by Jan von Beckerath at NIMIUS and optimized by Stefan Nitzsche.
License
This project is under the Open Source MIT license. Find more information in the LICENSE file.