Skip to content
Node.js package template http://winton.github.io/node-template
CoffeeScript Shell JavaScript
Find file
Pull request Compare This branch is 34 commits ahead of master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
bin
config
migrations
src
tasks
test
.gitignore
.npmignore
.travis.yml
Gruntfile.coffee
README.md
package.json

README.md

NodeTemplate - bookshelf

Node.js package template with a database ORM.

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> bookshelf

Other 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.