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

https://github.com/andre-araujo/package-boilerplate

A simple boilerplate for npm modules
https://github.com/andre-araujo/package-boilerplate

Last synced: 2 months ago
JSON representation

A simple boilerplate for npm modules

Awesome Lists containing this project

README

        

# Npm package boilerplate.

Npm package boilerplate is a simple scafold to create npm modules.

It's a easy way to publish npm modules with the latest javascript features, eslint, and test ready.

## Usage

- clone the project
- modify package.json as you want
- `npm install`

## Building

`npm run build`

## Testing

Testing is the simple way to make sure that your code is working!

Npm package boilerplate comes with `jest` as a test tool, to make sure that tests will work, make sure to run `npm install` before.

Test names should be in the following pattern:
`*.spec.js`

`npm test`

## Publishing

`npm publish`