https://github.com/tur-nr/node-module-boilerplate

Opinionated boilerplate for creating new Node.js modules.
https://github.com/tur-nr/node-module-boilerplate

boilerplate javascript module node template

Last synced: 3 months ago
JSON representation

Opinionated boilerplate for creating new Node.js modules.

• Host: GitHub
• URL: https://github.com/tur-nr/node-module-boilerplate
• Owner: tur-nr
• License: mit
• Created: 2017-03-09T23:11:42.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-10T01:11:00.000Z (over 8 years ago)
• Last Synced: 2025-02-02T00:51:10.270Z (4 months ago)
• Topics: boilerplate, javascript, module, node, template
• Language: JavaScript
• Homepage:
• Size: 46.9 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Node.js Module Template

![Dependencies Status](https://david-dm.org/tur-nr/node-module-template.svg)

[![Build Status](https://travis-ci.org/tur-nr/node-module-template.svg?branch=master)](https://travis-ci.org/tur-nr/node-module-template)

[![Coverage Status](https://coveralls.io/repos/github/tur-nr/node-module-template/badge.svg?branch=master)](https://coveralls.io/github/tur-nr/node-module-template?branch=master)

[![XO code style](https://img.shields.io/badge/code_style-XO-5ed9c7.svg)](https://github.com/sindresorhus/xo)

Opinionated boilerplate for creating new [Node.js](https://nodejs.org/en/) modules.

## Usage

Fork repository. Write your code in `src/` and tests in `test/`.

### Building

```sh

yarn run build

```

### What's Inside

- [Yarn](https://yarnpkg.com) package manager.

- [Babel](https://babeljs.io), esnext ([`babel-preset-env`](https://github.com/babel/babel-preset-env)).

- [Gulp](http://gulpjs.com), task and build tool.

- [Jest](https://facebook.github.io/jest), test and coverage.

- [XO](https://github.com/sindresorhus/xo), linting and styling.

- [EditorConfig](http://editorconfig.org/), multi editor configuration.

- [TravisCI](https://travis-ci.org/), CI ready.

- [Coveralls](https://coveralls.io/), coverage reporter.

- [VSCode](https://code.visualstudio.com/), editor linting and fixing ([`vscode-linter-xo`](https://github.com/SamVerschueren/vscode-linter-xo)).

## License

[MIT](LICENSE)

Copyright (c) 2017 [Christopher Turner](https://github.com/tur-nr)