https://github.com/appleboy/slush-html5-template
html5 template engine generator (RequireJS/CoffeeScript/Compass/jQuery/Mocha) for Slush.
https://github.com/appleboy/slush-html5-template
Last synced: 9 months ago
JSON representation
html5 template engine generator (RequireJS/CoffeeScript/Compass/jQuery/Mocha) for Slush.
- Host: GitHub
- URL: https://github.com/appleboy/slush-html5-template
- Owner: appleboy
- License: mit
- Created: 2014-06-07T06:59:32.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2017-04-29T14:19:54.000Z (over 8 years ago)
- Last Synced: 2024-04-13T21:23:14.967Z (almost 2 years ago)
- Language: CSS
- Homepage:
- Size: 290 KB
- Stars: 10
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# [slush](https://github.com/slushjs/slush)-html5-template
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [](https://travis-ci.org/appleboy/slush-html5-template) [](https://gemnasium.com/appleboy/slush-html5-template)
[](https://nodei.co/npm/slush-html5-template/)
> Slush generator Html5 web apps
## Features
* The latest [html5boilerplate.com](http://html5boilerplate.com/) source code.
* Includes [Normalize.scss](https://github.com/appleboy/normalize.scss) v3.0.x and v1.1.x.
* The latest [jQuery](http://jquery.com/) and [Modernizr](http://modernizr.com/) via [Bower](http://bower.io/) package manager.
* Support [CoffeeScript](http://coffeescript.org/), [RequireJS](http://requirejs.org/), [Sass](http://sass-lang.com/) or [Compass](http://compass-style.org/), html minification (via [htmlcompressor](http://code.google.com/p/htmlcompressor/)).
* Support JavaScript test framework [Mocha](http://mochajs.org/).
* Support streaming build system [Gulp](http://gulpjs.com/).
* Support Minify PNG and JPEG images with [image-min](https://github.com/sindresorhus/gulp-imagemin).
* Support [browser-sync](http://browsersync.io) Keep multiple browsers & devices in sync when building websites.
## Getting Started
### Installation
Install `slush-html5-template` globally:
```bash
$ npm install -g slush-html5-template
```
Remember to install `slush` globally as well, if you haven't already:
```bash
$ npm install -g slush
```
### Usage
Create a new folder for your project:
```bash
$ mkdir my-slush-html5-template
```
Run the generator from within the new folder:
```bash
$ cd my-slush-html5-template && slush html5-template
```
## Quick start
### run application
To run the application
```bash
$ npm start
```
### Release application
To build application
```bash
$ npm run release
```
### Testing application
To test the application
```bash
$ npm test
```
### ScreenShot
[npm-url]: https://www.npmjs.org/package/slush-html5-template
[npm-image]: http://img.shields.io/npm/v/slush-html5-template.svg
[downloads-image]: http://img.shields.io/npm/dm/slush-html5-template.svg