# npm-mod-start

> An npm module starter kit

Latest version **1.1.2** (published 2019-04-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-mod-start
pnpm add npm-mod-start
yarn add npm-mod-start
bun add npm-mod-start
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.2 |
| Published | 2019-04-25 |
| First published | 2018-11-18 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 11.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Brendan Conrad |
| Maintainers | brencon |
| Keywords | npm, module, starter-kit, nodejs, library |

## Links

- npm: https://www.npmjs.com/package/npm-mod-start
- Repository: https://github.com/brencon/npm-mod-start
- Homepage: https://github.com/brencon/npm-mod-start#readme
- Issues: https://github.com/brencon/npm-mod-start/issues
- npm.io page: https://npm.io/package/npm-mod-start

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 1.1.2 (latest) — 2019-04-25
- 1.1.1 — 2019-04-25
- 1.0.0 — 2018-11-18
- 0.0.9 — 2018-11-18
- 0.0.8 — 2018-11-18
- 0.0.7 — 2018-11-18
- 0.0.6 — 2018-11-18
- 0.0.5 — 2018-11-18
- 0.0.4 — 2018-11-18
- 0.0.3 — 2018-11-18
- 0.0.2 — 2018-11-18
- 0.0.1 — 2018-11-18

## README

# PLEASE READ
The information provided in this README should be the details for *your* project. The section here located above the badges can be removed.

## How to Use This Project
* Clone this repo into a new folder
* Delete the .git folder
* Find and replace all occurrences of "npm-mod-start" with the name of your project
* Reset the version in package.json to your project's version

__________________________________________________

[![Build Status](https://travis-ci.org/brencon/npm-mod-start.svg?branch=master)](https://travis-ci.org/brencon/npm-mod-start) [![Coverage Status](https://coveralls.io/repos/github/brencon/npm-mod-start/badge.svg?branch=master)](https://coveralls.io/github/brencon/npm-mod-start?branch=master)

[![NPM](https://nodei.co/npm/npm-mod-start.png)](https://nodei.co/npm/npm-mod-start/)

# npm-mod-start
An npm module starter kit

## Overview
This is a starter kit for building an npm module. It includes a framework for documentation, project file and folder structure hierarchy, continuous integration, and unit testing with code coverage.

## Installation

### npm
`npm install npm-mod-start -S`

## Tests
`npm test`

## Code Quality
Code quality will be checked using eslint with the `--fix` argument so repair easily-fixed rule-breaking code.

`npm run lint`

## Code Coverage
Code coverage is maintained by using the nyc command-line-client for [Istanbul](https://istanbul.js.org/) with [Coveralls](https://coveralls.io) reporting.

## Continuous Integration
Continuous integration provided by [Travis CI](https://travis-ci.org).

## Contributing
In lieu of a formal style guide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.

## Community
Updates and discussions about this module can be found [@symBrendan on Twitter](https://twitter.com/symBrendan).

## Versioning
For transparency into a common release cycle to strive toward maintaining backward compatibility, this project is maintained under [the Semantic Versioning guidelines](http://semver.org/).

### Creating a New Version
The following commands will create a new version of the module, automatically create a new tag with the same value as the version, push the tags to the remote, and, finally, push the code to the remote.

#### Stage your files
`git add .`

#### Commit with message
`git commit -m "your commit message"`

#### Publish the module to npmjs.org
The `npm publish` command will create a patch in package.json, add a new tag, push the tag, and publish the changes to npmjs.

`npm publish`

## Creator

**Brendan Conrad**

- <https://twitter.com/symBrendan>

## License
This project is licensed under the terms of the MIT license.

---
_Source: https://npm.io/package/npm-mod-start · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._