https://github.com/commercetools/nodejs-boilerplate
https://github.com/commercetools/nodejs-boilerplate
audit-import-export
Last synced: about 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/commercetools/nodejs-boilerplate
- Owner: commercetools
- License: mit
- Created: 2016-09-06T10:06:35.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-06-18T08:09:12.000Z (about 8 years ago)
- Last Synced: 2025-04-20T15:17:58.862Z (about 1 year ago)
- Topics: audit-import-export
- Language: Shell
- Homepage:
- Size: 14.6 KB
- Stars: 9
- Watchers: 72
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[![commercetools logo][commercetools-icon]][commercetools]
# Node.js boilerplate
[![Travis Build Status][travis-icon]][travis]
[![Codecov Coverage Status][codecov-icon]][codecov]
[![David Dependencies Status][david-icon]][david]
[![David devDependencies Status][david-dev-icon]][david-dev]
Start your next [Node.js commercetools](http://commercetools.github.io/nodejs-tools/) 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][tape] for testing.
## Requirements
Make sure you have installed all of the following prerequisites on your development machine:
* Git - [Download & Install Git](https://git-scm.com/downloads). MacOS and Linux machines typically have this already installed.
* Node.js - [Download & Install Node.js](https://nodejs.org/en/download/) 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](https://github.com/tj/n) or [nvm](https://github.com/creationix/nvm).
## Usage
1. Clone this repository:
```bash
git clone --depth=1 https://github.com/commercetools/nodejs-boilerplate.git
```
2. 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':
```bash
sh setup.sh awesome-cli bin
```
3. Now you're ready for liftoff!
[commercetools]: https://commercetools.com/
[commercetools-icon]: https://cdn.rawgit.com/commercetools/press-kit/master/PNG/72DPI/CT%20logo%20horizontal%20RGB%2072dpi.png
[travis]: https://travis-ci.org/commercetools/nodejs-boilerplate
[travis-icon]: https://img.shields.io/travis/commercetools/nodejs-boilerplate/master.svg?style=flat-square
[codecov]: https://codecov.io/gh/commercetools/nodejs-boilerplate
[codecov-icon]: https://img.shields.io/codecov/c/github/commercetools/nodejs-boilerplate.svg?style=flat-square
[david]: https://david-dm.org/commercetools/nodejs-boilerplate
[david-icon]: https://img.shields.io/david/commercetools/nodejs-boilerplate.svg?style=flat-square
[david-dev]: https://david-dm.org/commercetools/nodejs-boilerplate?type=dev
[david-dev-icon]: https://img.shields.io/david/dev/commercetools/nodejs-boilerplate.svg?style=flat-square
[tape]: https://www.npmjs.com/package/tape