@imed.ch/imed-template

imed-template

some template for nodejs module

---

Follow these steps :

WARNING !! THIS MODULE IS NOT INTENDED TO BE INSTALLED !!

1. Click on "Use this Template" button on the main page repository and create a new repository from imed-template.

2. Clone your own repository :

    git clone https://github.com/<username>/<module-name>.git
   

   Now edit the project with your favorite editor and do : ...

3. Find/Replace "imed-template" with your own npm "module-name", e.g. in :

   • index.js
   • jsdoc.json
   • package.json
   • README.md

4. Find/Replace "@imed.ch" with your own npm "scope", if you dont have a scope, replace "@imed.ch/" (suffixed with slash) with "", e.g. in :

   • jsdoc.json
   • package.json
   • README.md

5. Find/Replace "jguillod" with your own git "username", e.g. in :

   • package.json
   • README.md

6. Now code your module :

   • ALWAYS install dev dependencies with

       npm i
     

   • Optionally install your required modules with

       npm i -S <some-module> ...
     

   • Edit README.md with your module specs and delete this section "Follow these steps". Also, delete Backers and Sponsors badges and sections when appropriate.

   • Edit index.js and any src/ or lib/ javascript files (i.e. code your module).

   • Write JSDoc comments to document your code.

   • Edit test/ files.

7. Test your module :

    	npm test
   

8. Commit and push to your git repository.

   • Commit, push and publish your module :

       git status
       git add package.json index.js src/ test/ etc.
     

     then, either (A) or (B) :

     (A) Safe way :

       git commit -m "module first update"
       npm version patch -m "Patched to %s with corrections"
       git push origin master --tags
       npm publish --access public
     

     (B) Fast way using using --force I sure hope you know what you are doing :

       npm version patch --force -m "Patched to %s with corrections"
       git push origin master --tags
       npm publish --access public
     

Install

npm i -S @imed.ch/imed-template

Usage

TODO

Tests

npm test

Documentation

npm run docs

will generate the documentation and open its index.html file. It's a shortcut of:

npm run generate-docs
npm run show-docs

Last command should open file ./docs/node-ifconfig.me/<version>/index.html (e.g. ./docs/node-ifconfig.me/0.1.0/index.html) in your browser.

Release History

• 0.2.2 cleaning -- Sun Jul 28 09:43:52 CEST 2019
• 0.1.0 base template -- Wed Jul 17 19:33:38 CEST 2019

BACKERS

Find imed-template helpful? Become a backer and support imed-template with a monthly donation.

SPONSORS

Use imed-template at Work? Ask your manager or marketing team if they'd help support our project. Your company's logo will also be displayed on npmjs.com and our GitHub repository.