@nejcm/js-library-boilerplate v1.2.4

📦 JS library boilerplate

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, ISSUE_TEMPLATE, etc...

📦 Getting Started

Built With

• Love :heart:

Prerequisites

• Node.js >=8

💿 Installation

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

# 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

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 Issue label.

🐛 Bugs

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

See 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

❓ 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, LinkedIn )

Contributors

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

Support

Reach out to us at one of the following places:

• 🌐 Website
• 📧 Email

LICENSE

MIT