https://github.com/rakuten-frontend/generator-rff
Fully customizable Yeoman generator for scaffolding a front-end web app.
https://github.com/rakuten-frontend/generator-rff
boilerplate grunt scaffolding yeoman yeoman-generator
Last synced: 7 months ago
JSON representation
Fully customizable Yeoman generator for scaffolding a front-end web app.
- Host: GitHub
- URL: https://github.com/rakuten-frontend/generator-rff
- Owner: rakuten-frontend
- License: mit
- Created: 2014-10-08T02:34:30.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-07-05T05:44:15.000Z (almost 9 years ago)
- Last Synced: 2024-10-12T20:54:12.204Z (8 months ago)
- Topics: boilerplate, grunt, scaffolding, yeoman, yeoman-generator
- Language: JavaScript
- Homepage:
- Size: 512 KB
- Stars: 26
- Watchers: 16
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# generator-rff
> Fully customizable Yeoman generator for scaffolding a front-end web app.
[![NPM Version][npm-image]][npm-url]
[![Build Status][travis-image]][travis-url]
[![Dependency Status][deps-image]][deps-url]
## Demo
[](http://youtu.be/jGzqR6-jAYE)
## Features
### Supported languages
* **Markup**
* HTML
* Pug
* **Stylesheet**
* CSS
* Sass
* Less
* Stylus
* **Script**
* JavaScript
* CoffeeScript
### Tasks and functions
* **Utilities**
* Wiring up Bower Components (Built-in)
* CSS Autoprefixer
* CSS Sprites Generator
* Icon Fonts Generator
* **Testing**
* HTML Validation
* CSS Lint
* JSHint
* JSCS
* Mocha
* Jasmine
* **Preview Server**
* BrowserSync (Built-in)
* SSI Support
* **Support Libraries**
* Modernizr
* **Optimization**
* Image Optimization (Built-in)
* HTML Minification
* CSS Minification
* JavaScript Minification
* Static Assets Revisioning
* **Distribution**
* Deployment to Git Repository
* Deployment over FTP
## Getting started
Make sure you have [Node.js](https://nodejs.org/) and [yo](https://github.com/yeoman/yo) installed:
```sh
$ npm install -g yo
```
To install generator-rff, run:
```sh
$ npm install -g generator-rff
```
Make a new directory, and cd into it:
```sh
$ mkdir my-new-project && cd $_
```
Finally, initiate the generator:
```sh
$ yo rff
```
## Generator options
* `-s`, `--skip-install`
Skips the automatic execution of `bower` and `npm` after scaffolding has finished.
* `--config=`
Setup type. If specified, the first prompt will be skipped.
You can set `standard`, `minimum`, `user` or `custom`.
* `--skip-welcome-message`
Skips app welcome message.
* `--skip-install-message`
Skips app installation message.
## See also
* [Yeoman](http://yeoman.io/) : Modern workflows for modern webapps
* [Grunt](http://gruntjs.com/) : The JavaScript task runner
* [Bower](http://bower.io/) : Package manager for the web
## License
Copyright (c) 2014-2016 Rakuten, Inc.
Licensed under the [MIT License](LICENSE).
[npm-image]: https://img.shields.io/npm/v/generator-rff.svg
[npm-url]: https://www.npmjs.com/package/generator-rff
[travis-image]: https://travis-ci.org/rakuten-frontend/generator-rff.svg?branch=master
[travis-url]: https://travis-ci.org/rakuten-frontend/generator-rff
[deps-image]: https://david-dm.org/rakuten-frontend/generator-rff.svg
[deps-url]: https://david-dm.org/rakuten-frontend/generator-rff