Project generator for Reaction NodeJS projects. Built with Yeoman.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
generators
.editorconfig
.eslintignore
.gitattributes
.gitignore
.prettierignore
CODE_OF_CONDUCT.md
LICENSE
README.md
package-lock.json
package.json

README.md

generator-reaction

NPM version CircleCI

This is a Yeoman generator plugin used by Reaction Commerce developers. The main generator creates a new project. There are also subgenerators for creating a new NPM package project and for quickly adding GraphQL files to the main Reaction project.

Installation

First, globally install Yeoman and generator-reaction using npm (we assume you have pre-installed node.js).

npm install -g yo generator-reaction

NPM Link

If you are adding or modifying generators in this package, you can test them prior to publishing by running npm link in the generator project's root directory to make the template available globally on your system.

npm link

Generate a new frontend or backend Node project

mkdir project-name
cd project-name
yo reaction

Generate a new NPM package project

mkdir package-name
cd package-name
yo reaction:npm

Generate GraphQL files in the main Reaction app

yo reaction:graphql

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

Commit Messages

To ensure that all contributors follow the correct message convention, each time you commit your message will be validated with the commitlint package, enabled by the husky Git hooks manager.

Examples of commit messages: https://github.com/semantic-release/semantic-release

Publication to NPM

The generator-reaction package is automatically published by CI when commits are merged or pushed to the master branch. This is done using semantic-release, which also determines version bumps based on conventional Git commit messages.

License

GPL-3.0 © Reaction Commerce, Inc.