@nejcm/js-library-boilerplate

Starter kit for your js library projects.

!NPMnpm-badgenpm-link !JavaScript Style Guidestyle-guide-badgestyle-guide
!Build Statusbuild-badgebuild !Semantic releasesemantic-release-badgesemantic-release !Code Coveragecoverage-badgecoverage !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !MIT Licenselicense-badgelicense
!Storybookstorybook-badge
!All Contributorsall-contributors-badge !PRs Welcomeprs-badgeprs !Code of Conductcoc-badgecoc
!Watch on GitHubgithub-watch-badgegithub-watch !Star on GitHubgithub-star-badgegithub-star

Table of Contents

• ⭐️ Features
• 📦 Getting started
• 💿 Installation
• 💎 Customization
• ⚙️ Configuration
• 🚀 Deployment
• 🎓 Versioning
• 🧪 Tests
• 💄 Style guide
• Issues

- 🐛 Bugs - 💡 Feature Requests - ❓ Questions

• Authors
• Contributors
• Support
• LICENSE

⭐️ Features

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

📦 Getting Started

Built With

• Love :heart:

Prerequisites

• Node.js >=8

💿 Installation

This module is distributed via npmnpm which is bundled with nodenode.

# 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

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

⚙️ Configuration

Check package.json for configuration options.

🚀 Deployment

npm run build

🎓 Versioning

We use SemVer for versioning. For the versions available see the link to tags on this repository.

🧪 Tests

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 Issuegood-first-issue label.

🐛 Bugs

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

💡 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 Requestsrequests

❓ Questions

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

Authors

• Nejc Muršič ( GitHubgithub, LinkedInlinkedin )

Contributors

<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>

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

Support

Reach out to us at one of the following places:

• 🌐 Websitewebsite
• 📧 Emailemail

LICENSE

MIT