@amindunited/node-package-boilerplate

Node Package Boilerplate

A seed project for spinning up, testing and publishing a node package

Setup

• Create a project in your chosen VCS, check it out, CD into it or:

git clone [e-mail]:YOURNAME/YOUR-PACKAGE.git && cd ./YOUR-PACKAGE

or

• Create a directory:

mkdir YOUR-PACKAGE && cd $_

• Make sure that you are logged in to npm:

npm login

• Initialise the project

# Replace <org_scope> with your @my-org name
npm init --scope=<org_scope>

• Make the sh file executable and run it:

chmod 777 build.sh && ./build.sh