📦 JS library boilerplate
Starter kit for your js library projects.
Table of Contents
⭐️ Features📦 Getting started💿 Installation💎 Customization⚙️ Configuration🚀 Deployment🎓 Versioning🧪 Tests💄 Style guide- Issues
- 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
❤️
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:
- Edit
LICENSEfile - Edit
package.jsoninformation (These will be used to generate the headers for your built files) - Replace and fill in [FILL], [FILL:...] tags with your information
- 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.
💡 Feature Requests
Please file an issue to suggest new features. Vote on feature requests by adding
a
❓ Questions
For questions related to using the library, please first read the docs instead of filing an issue on GitHub.
Authors
Contributors
Nejc Muršič |
This project follows the all-contributors specification. Contributions of any kind welcome!
Support
Reach out to us at one of the following places: