Skip to content

commercetools/nodejs-boilerplate

Repository files navigation

commercetools logo

Node.js boilerplate

Travis Build Status Codecov Coverage Status David Dependencies Status David devDependencies Status

Start your next Node.js commercetools project in seconds.

Features

  • Babel: use new JavaScript features while keeping compatibility.
  • TravisCI: config and setup included.
  • ESLint: config to keep the coding style consistent.
  • Templates: includes readme and package.json templates.
  • Tests: uses tape for testing.

Requirements

Make sure you have installed all of the following prerequisites on your development machine:

  • Git - Download & Install Git. MacOS and Linux machines typically have this already installed.
  • Node.js - Download & Install Node.js and the npm package manager. Make sure to get the latest active LTS version. You could also use a Node.js version manager such as n or nvm.

Usage

  1. Clone this repository:
git clone --depth=1 https://github.com/commercetools/nodejs-boilerplate.git
  1. Clean up, setup and install with setup.sh.
    You can pass in optional arguments like the project name and an additional directory name that you want to use, for example 'bin':
sh setup.sh awesome-cli bin
  1. Now you're ready for liftoff!