generator-frontend

Front end architecture generator for new projects at Emakina NL. This package assists in the creation of the folder structure (using ITCSS), gulpfile and package.json. It uses the Yeoman package generator.

Installation

First, install Yeoman and then create a local generator-frontend package using npm npm (we assume you have pre-installed node.js).

In any folder run:

npm install -g yo

RUN THIS STEP IF INSTALLING PACKAGE FROM REPO

Inside the generator-frontend you just cloned from git, run:

npm link

RUN THIS STEP TO INSTALL FROM PUBLISHED NPM PACKAGE

Inside the generator-frontend you just cloned from git, run:

npm install -g generator-emakina-frontend

Then generate your new project in the folder of your choice:

yo emakina-frontend

Prompts on creation

When running the generator you will get a few questions

• Name of the project: will be used in package.json
• Create gulp file: If answered 'yes', the generator will assist in the creation of this gulpfile. For now, it will always create sass tasks by default, and ask if the user also wants tasks to create sprites (png and svg), add iconfonts, or compile and lint JS. These options will evolve until we get the option to have the gulp setup described in the Gulp repo.

To Do:

• Adjust watch tasks : only run the necessary tasks to build what has changed;
• Review prompts (maybe a checkbox list instead of separate questions?);
• Add a relevant gitignore, eslint and editorconfig files;
• Add prompts about base paths.