npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@nejcm/js-library-boilerplate

v1.2.4

Published

Starter kit for your js library projects.

Downloads

34

Readme

📦 JS library boilerplate

NPM JavaScript Style Guide

Build Status Semantic release Code Coverage version downloads MIT License

Storybook

All Contributors PRs Welcome Code of Conduct

Watch on GitHub Star on GitHub

Table of Contents

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

Contributors

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

Support

Reach out to us at one of the following places:

LICENSE

MIT