slush-bootstrap

A Slush generator for Bootstrap SASS/LESS/CSS/Stylus projects

Getting Started

Installation

Install slush-bootstrap globally:

$ npm install -g slush-bootstrap

Remember to install gulp & slush globally as well, if you haven't already:

$ npm install -g gulp slush

Then pick stylesheet engine among

• CSS
• SASS
• LESS
• Stylus

Features

• All bootstrap templates are integrated with the scaffolded project. All you need to do is pull the required template from dev/templates folder and use it.
• Watch task with csslint, jslint and stylesheet compiling.
• Build process runs a cssmin, jsmin, imagemin and copies the required files to /build folder. The build task uses useref, if needed you can inject your own styles and scripts.

Usage

Create a new folder for your project:

$ mkdir my-slush-bootstrap

Run the generator from within the new folder:

$ cd my-slush-bootstrap && slush bootstrap

Run the app

To run the app, execute

$ gulp 

and navigate to http://localhost:3000 to see the starter template. You can checkout dev/templates folder for integrated Bootstrap templates.

To build the project (except templates folder) to /build folder, run

$ gulp build

To run the built app, execute

$ gulp prod

Todos

• [x] Boostrap CSS
• [x] Boostrap SASS
• [x] Boostrap LESS
• [x] Boostrap Stylus
• [ ] Add coffee script support
• [ ] Add gulp-local-screenshots support

Getting To Know Slush

Slush is a tool that uses Gulp for project scaffolding.

Slush does not contain anything "out of the box", except the ability to locate installed slush generators and to run them with liftoff.

To find out more about Slush, check out the documentation.

Contributing

See the CONTRIBUTING Guidelines

Support

If you have any problem or suggestion please open an issue here.

License

The MIT License

Copyright (c) 2014, Arvind

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.