generator-d2-ui-component

Yeoman generator

Getting Started

Installing Yeoman?

npm install -g yo

Additional dependencies outside of npm

#Ruby gems to run Sass css preprocessor (You might have to use sudo to install the ruby gem.)

#Sass
gem install sass 

#Compass
gem install compass

#The following gems are not required (If you do not wish to use them remove them from the generated config.rb)
#in the project root folder.
gem install normalize-scss
gem install compass
gem install breakpoint
gem install susy

Yeoman Generator

To install generator-d2-ui-component from npm, run:

npm install -g generator-d2-ui-component

Finally, initiate the generator:

yo d2-ui-component

Included generators

# Will generate the basic component project and install the npm dependencies
# - .eslintrc, karma.config.js, .editorconfig, .gitignore, config.rb, package.json
# - Will also run the component generator below
yo d2-ui-component

# Will generate an additional React component and test file
# - src/<ComponentName>.component.js
# - test/<ComponentName>.component.test.js
# - scss/<ComponentName>.scss
yo d2-ui-component:component

License

MIT