Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Node.js package template
CoffeeScript Shell JavaScript

README

latest commit 736353b8d5
@winton authored
Failed to load latest commit information.
bin Remove grunt setup:branch in favor of doing merges manually
src
tasks Using initConfig overwriting existing grunt config
test Adding test coverage via grunt mocha
.gitignore Adding test coverage via grunt mocha
.npmignore
.travis.yml
Gruntfile.coffee
README.md
package.json Adding test coverage via grunt mocha

README.md

NodeTemplate

Node.js package template.

Goals

  • Use widely accepted practices and libraries
  • Automate the creation and renaming of projects
  • Projects share git history for easy updates
  • Add functionality through template branches

Install

npm install node-template -g

Create a new project

node-template <project-name> <branch>

Available branches:

Coffeescript (optional)

Run grunt to watch for Coffeescript changes in src and compile them to lib.

Start working

Run grunt to watch for changes in src and compile them to lib.

Tests

Run grunt mocha to execute your test suite with coverage statistics.

The npm test command runs the test suite without coverage (Travis-CI).

Contribute

Create an issue to discuss template changes.

Pull requests for template changes and new branches are even better.

Stay up to date

Watch this project on Github.

Follow Winton Welsh on Twitter.

Something went wrong with that request. Please try again.