Skip to content
This repository has been archived by the owner on Jul 30, 2018. It is now read-only.
/ npm-boilerplate Public archive

Boilerplate for NPM package with Mocha, CoffeeScript and test directory structure

License

Notifications You must be signed in to change notification settings

apiaryio/npm-boilerplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

npm-boilerplate

Build Status Dependency Status devDependency Status

Scripts

  • scripts/bdd - watch on file changes and run Mocha tests if some file changes
  • scripts/build - remove /lib directory and render .coffee files from /src
  • scripts/prepublish - run test and if passed then build
  • scripts/test - run tests

Edit defaults

  • Edit package name in Travis-CI and David-DM badges in this readme
  • Edit package json:
    • package name
    • pacakge description
    • path to your main file
    • version
    • author
    • keywords
    • repository
    • homepage
    • do not forget to add possible executables to bin section

Add example usage

var boilerplate = require('npm-boilerplate');

boilerplate = boilerplate.boil(something);

console.log(boilerplate);

See more additional description

Add API Reference

boil(something) - boils a plate


NOTE: Add some possible note

About

Boilerplate for NPM package with Mocha, CoffeeScript and test directory structure

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published