npm package: @nejcm/js-library-boilerplate
Description: Starter kit for your js library projects.
Author: Nejc Mursic
Latest version: 1.2.4

# 📦 JS library boilerplate
<blockquote>Starter kit for your js library projects.</blockquote>
<br />

<!-- prettier-ignore-start -->
[![NPM][npm-badge]][npm-link] 
[![JavaScript Style Guide][style-guide-badge]][style-guide]

[![Build Status][build-badge]][build]
[![Semantic release][semantic-release-badge]][semantic-release]
[![Code Coverage][coverage-badge]][coverage]
[![version][version-badge]][package] [![downloads][downloads-badge]][npmtrends]
[![MIT License][license-badge]][license]

[![Storybook][storybook-badge]]([storybook])

[![All Contributors][all-contributors-badge]](#contributors)
[![PRs Welcome][prs-badge]][prs] [![Code of Conduct][coc-badge]][coc]

[![Watch on GitHub][github-watch-badge]][github-watch]
[![Star on GitHub][github-star-badge]][github-star]
<!-- prettier-ignore-end -->

## Table of Contents

<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [⭐️ Features](#-features)
- [📦 Getting started](#-getting-started)
- [💿 Installation](#-installation)
- [💎 Customization](#-customization)
- [⚙️ Configuration](#-configuration)
- [🚀 Deployment](#-deployment)
- [🎓 Versioning](#-versioning)
- [🧪 Tests](#-tests)
- [💄 Style guide](#-style-guide)
- [Issues](#issues)
  - [🐛 Bugs](#-bugs)
  - [💡 Feature Requests](#-feature-requests)
  - [❓ Questions](#-questions)
- [Authors](#authors)
- [Contributors](#contributors)
- [Support](#support)
- [LICENSE](#license)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## ⭐️ Features

- Rollup 2
- Babel 7
- Jest unit testing
- Test coverage and badges
- Storybook
- Travis
- Docs
- File templates for TODO, README, CONTRIBUTING, ISSUE_TEMPLATE, etc...


## 📦 Getting Started

### Built With

- Love :heart:

### Prerequisites

- Node.js >=8

## 💿 Installation

This module is distributed via [npm][npm] which is bundled with [node][node].

```shell

# clone project
git clone https://github.com/nejcm/js-library-boilerplate.git my-project

# move into project
cd my-project

# install deps
npm install

```


## 💎 Customization

> Before shipping, make sure to:
1. Edit `LICENSE` file
2. Edit `package.json` information (These will be used to generate the headers for your built files)
3. Replace and fill in [FILL], [FILL:...] tags with your information
4. Remove any files you do not need or edit them accordingly

## ⚙️ Configuration

Check _package.json_ for configuration options.

## 🚀 Deployment

```shell
npm run build
```


## 🎓 Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available see the [link to tags on this repository](/tags).


## 🧪 Tests

```shell
npm run tests
```

## 💄 Style guide

The code styles followed are documented and set with linter rules inside _.eslintrc_ file.


## Issues

_Looking to contribute? Look for the [Good First Issue][good-first-issue] label._

### 🐛 Bugs

Please file an issue for bugs, missing documentation, or unexpected behavior.

[**See Bugs**][bugs]

### 💡 Feature Requests

Please file an issue to suggest new features. Vote on feature requests by adding
a 👍. This helps maintainers prioritize what to work on.

[**See Feature Requests**][requests]

### ❓ Questions

For questions related to using the library, please first read the docs
instead of filing an issue on GitHub.

## Authors

- Nejc Muršič ( [GitHub][github], [LinkedIn][linkedin] )

## Contributors

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->

<table>
  <tr>
    <td align="center">
      <a href="https://github.com/nejcm">
      <img src="https://avatars3.githubusercontent.com/u/1865210?v=3" width="100px" alt="Nejc"/>
      <br />
      <sub><b>Nejc Muršič</b></sub>
    </a>
    <br />
    <a href="https://github.com/nejcm/js-library-boilerplate/commits?author=nejcm" title="Code">💻</a> 
    <a href="https://github.com/nejcm/js-library-boilerplate/commits?author=nejcm" title="Documentation">📖</a> 
    <a href="#infra" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> 
    <a href="https://github.com/nejcm/js-library-boilerplate/commits?author=nejcm" title="Tests">⚠️</a>
  </td>
  </tr>
</table>

<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the [all-contributors][all-contributors] specification.
Contributions of any kind welcome!

## Support

Reach out to us at one of the following places:

- [🌐 Website][website]
- [📧 Email][email]

## LICENSE

[MIT](LICENSE)


<!-- prettier-ignore-start -->

[all-contributors-badge]: https://img.shields.io/badge/all_contributors-1-orange.svg
[all-contributors]: https://github.com/all-contributors/all-contributors
[bugs]: https://github.com/nejcm/js-library-boilerplate/issues?q=is%3Aissue+is%3Aopen+label%3Abug+sort%3Acreated-desc
[build-badge]: https://img.shields.io/travis/com/nejcm/js-library-boilerplate.svg
[build]: https://travis-ci.com/nejcm/js-library-boilerplate
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg
[coc]: https://github.com/nejcm/js-library-boilerplate/blob/master/CODE_OF_CONDUCT.md
[coverage-badge]: https://img.shields.io/codecov/c/github/nejcm/js-library-boilerplate.svg
[coverage]: https://codecov.io/github/nejcm/js-library-boilerplate
[downloads-badge]: https://img.shields.io/npm/dm/@nejcm/js-library-boilerplate.svg
[email]: nmursi2@gmail.com
[emojis]: https://github.com/all-contributors/all-contributors#emoji-key
[github]: https://github.com/nejcm
[github-star-badge]: https://img.shields.io/github/stars/nejcm/js-library-boilerplate.svg?style=social
[github-star]: https://github.com/nejcm/js-library-boilerplate/stargazers
[github-watch-badge]: https://img.shields.io/github/watchers/nejcm/js-library-boilerplate.svg?style=social
[github-watch]: https://github.com/nejcm/js-library-boilerplate/watchers
[good-first-issue]: https://github.com/nejcm/js-library-boilerplate/issues?utf8=✓&q=is%3Aissue+is%3Aopen+sort%3Areactions-%2B1-desc+label%3A"good+first+issue"+
[license-badge]: https://img.shields.io/npm/l/@nejcm/js-library-boilerplate.svg
[license]: https://github.com/nejcm/js-library-boilerplate/blob/master/LICENSE
[linkedin]: https://www.linkedin.com/in/nejcm/
[node]: https://nodejs.org
[npm]: https://www.npmjs.com/
[npm-badge]: https://img.shields.io/npm/v/@nejcm/js-library-boilerplate.svg
[npm-link]: https://www.npmjs.com/package/@nejcm/js-library-boilerplate
[npmtrends]: http://www.npmtrends.com/@nejcm/js-library-boilerplate
[package]: https://www.npmjs.com/package/@nejcm/js-library-boilerplate
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg
[prs]: http://makeapullrequest.com
[requests]: https://github.com/nejcm/js-library-boilerplate/issues?q=is%3Aissue+sort%3Areactions-%2B1-desc+label%3Aenhancement+is%3Aopen
[semantic-release-badge]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-release]: https://github.com/semantic-release/semantic-release
[storybook-badge]: https://nejcmursic.netlify.com/assets/storybook.svg
[storybook]: https://storybook.js.org/
[style-guide-badge]: https://img.shields.io/badge/code_style-standard-brightgreen.svg
[style-guide]: https://standardjs.com
[version-badge]: https://img.shields.io/npm/v/@nejcm/js-library-boilerplate.svg
[website]: https://nejcmursic.com/

<!-- prettier-ignore-end -->