Install Yeoman
npm install -g yo
bash npm install -g generator-ibm-core-node-express
Following command line arguments are supported
--bluemix='{"name":"<project-name>","backendPlatform":"NODE"}'
.- You will need at least a name and backendPlatform to run it locally.
- You can alternatively supply a local file containing compatible JSON object by using
--bluemix file:path/to/file.json
Clone this repository and link it via npm
git clone https://github.com/ibm-developer/generator-ibm-core-node-express
cd generator-ibm-core-node-express
npm link
In a separate directory invoke the generator via
yo ibm-core-node-express --bluemix='{"name":"<project-name>","backendPlatform":"NODE"}'
In order to publish changes, you will need to fork the repository or ask to join the ibm-developer
org and branch off the master
branch.
Make sure to follow the conventional commit specification before contributing. To help you with commit a commit template is provide. Run config.sh
to initialize the commit template to your .git/config
.
Once you are finished with your changes, run npm test
to make sure all tests pass.
Do a pull request against master
, make sure the build passes. A team member will review and merge your pull request.
Once merged to master
one pull request will be created against master
. Make sure that the CHANGELOG.md and the package.json is correct before merging the auto generated pull request. After the autogenerated pull request has been merged to master
the version will be bumped and published to npm.