getting-started.md

English / 日本語

Getting started

Install prerequisites

First, install Node.js and npm. npm is bundled with Node.js.

• Node.js website
• Or you can install Node.js using nvm. (Advanced)

rff-gulp requires Node.js v4.0.0 or later.

$ node --version && npm --version

Then, install Yeoman which is a command line tool for generating projects.

$ npm install --global yo

Install rff-gulp generator

generator-rff-gulp is a Yeoman generator to create project using rff-gulp template.

$ npm install --global generator-rff-gulp

Create your project

Make a directory for your project.

$ mkdir my-gulp-project && cd my-gulp-project

Run Yeoman generator to create a project based on rff-gulp.

$ yo rff-gulp
# This will generate files and install node_modules.

Tip:
generator-rff-gulp automatically fetches the latest template on GitHub and create a project.
If you want to download the template manually, get it from the Releases page.

• Latest release
• All versions

Structure

my-gulp-project/
├── app/                 : Source code/files for web application
│   ├── styles/          : Stylesheets
│   ├── scripts/         : JavaScripts
│   ├── images/          : Images
│   │   └── _sprites/    : Base images for spritesheet
│   ├── fonts/           : Web fonts
│   │   └── _glyphs/     : Base SVG files for icon font
│   └── index.html       : Index page
├── gulpfile.js          : Build config
└── package.json         : Package information

Next step

See Workflow to start development.