Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/egoist/template-nm

Scaffold out a node module
https://github.com/egoist/template-nm

module nodejs npm package template

Last synced: about 2 months ago
JSON representation

Scaffold out a node module

Awesome Lists containing this project

README

        

template-nm


Scaffolding out a node module.


NPM version NPM downloads Build Status donate


preview

## Features

- Unit test with [jest](https://facebook.github.io/jest/)
- ESLint with [xo](https://github.com/sindresorhus/xo) or [standard](https://github.com/feross/standard)
- CircleCI [2.0](https://circleci.com/docs/2.0/) with npm^5 or yarn support
- Optionally [compile ES2015 code](./docs/compile-es2015.md) using [bili](https://github.com/unipahq/bili)
- Optionally [use Poi to run example](./docs/poi.md)
- Optionally add coverage report
- Optionally add CLI

## Usage

Install [SAO](https://github.com/egoist/sao) first.

### From git

```bash
sao egoist/template-nm
```

### From npm

```bash
sao nm
```

## License

MIT © EGOIST