tingpan/module-template-npm

Testmodulenpm

test_module_npm.

Installation

Install via npm:

npm install --save test_module_npm

Install via bower:

bower install --save test_module_npm

Submitting Issues

If have issues while using this module, please consider discussing it on Gitter channel first.

If you confirm the issue is indeed a bug, you can browse the issues page for existing issues describing the same problem.

If you found nothing on issues page, please create an new issue with detailed debug information, for example, reproduce procedure, error stacks, screenshots etc. Issues without enough debug information will probably be closed.

Development

Clone repository from github:

git clone https://github.com/tingpan/test_module_npm.git

Install npm dependencies:

npm install

Run default gulp task to build project, which will compile source files, run test and watch file changes for you:

gulp

Now, you are ready to go.

Publish

If you want to publish new version to npm and bower, please make sure all tests have passed before you publish new version, and you need do these preparations:

• Add new release information in CHANGELOG.md. The format of markdown contents will matter, because build scripts will get version and release content from this file by regular expression. You can follow the format of the older release information.

• Run gulp default task, which will get version number from CHANGELOG.md and bump it into package.json and bower.json, before you push the commit for new version.

• Put your personal API tokens in /.token.json, which is required by build scripts to request Github API:

{
  "github": "[your github personal access token]"
}

Now you can run gulp publish task, which will do these work for you:

• Generate the static doc site and push it to gh-pages branch.
• Get release information from CHANGELOG.md and request Github API to create new release.

If everything goes fine, you can publish new version to npm at the end:

npm publish