https://github.com/lucasconstantino/node-lib-boilerplate

A boilerplate for node-focused open-source libraries.
https://github.com/lucasconstantino/node-lib-boilerplate

boilerplate contrib library nodejs scafolding

Last synced: 2 months ago
JSON representation

A boilerplate for node-focused open-source libraries.

• Host: GitHub
• URL: https://github.com/lucasconstantino/node-lib-boilerplate
• Owner: lucasconstantino
• License: mit
• Created: 2019-02-19T03:24:53.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-04-16T16:35:34.000Z (about 7 years ago)
• Last Synced: 2025-03-22T00:35:27.372Z (over 1 year ago)
• Topics: boilerplate, contrib, library, nodejs, scafolding
• Language: JavaScript
• Size: 7.81 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Node Library Boilerplate

[![npm version](https://img.shields.io/npm/v/node-contrib-boilerplate.svg?style=flat-square)](https://www.npmjs.com/package/node-contrib-boilerplate)

[![Downloads/week](https://img.shields.io/npm/dw/node-contrib-boilerplate.svg)](https://npmjs.org/package/node-contrib-boilerplate)

[![License](https://img.shields.io/npm/l/node-contrib-boilerplate.svg)](https://github.com/lucasconstantino/node-contrib-boilerplate/blob/master/package.json)

[![build status](https://img.shields.io/travis/lucasconstantino/node-contrib-boilerplate/master.svg?style=flat-square)](https://travis-ci.org/lucasconstantino/node-contrib-boilerplate)

[![coverage](https://img.shields.io/codecov/c/github/lucasconstantino/node-contrib-boilerplate.svg?style=flat-square)](https://codecov.io/github/lucasconstantino/node-contrib-boilerplate)

**A boilerplate for node-focused open-source libraries.**

This boilerplate is the starting point for [Lucas's](https://github.com/lucasconstantino) node targeted open-source libraries.

---

## Motivation

[explain why] Everytime I needed to start a new open-source project focused on Node applications I had to go over the same setup all over again. Linting, testing, QA setup, compiling, etc, etc. This boilerplate aims to reduce this setup overhead by providing a ground-zero starting point for my own libraries - and for those who my enjoy it as well.

## Usage

> Clone this project, re-initialize Git, and go on with your life. The following is just to keep an example for future libraries ;)

### Installation

```

npm i node-contrib-boilerplate

```

### Usage

```js

import library from 'node-library-boilerplate'

// sample usage...

```