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

clarkcoolbutton

v0.0.2

Published

Just a cool button

Downloads

3

Readme

This is the complete example for this guide on publishing your React component to npm

Guide

  1. Replace contents in /src with your React component.

  2. Edit webpack.config.js, replace the following:

    1. entry: './src/YOUR_COMPONENT.js' Replace value of entry to path to the entry point of your component.
    2. Replace output.filename to the name of your component
    	output: {
    		path: path.resolve('lib'),
    		filename: 'YOUR_COMPONENT.js',
    		libraryTarget: 'commonjs2',
    },
  3. Edit package.json, replace the following:

    1. "name": "YOUR_PACKAGE_NAME" Replace the value of name to your package name. This will be the name of the package that is published to npm and the name that is used when other people install your package using npm install YOUR_PACKAGE_NAME.
    2. Update the values of version and description to accordingly.
    3. "main": "./lib/YOUR_COMPONENT.js" replace YOUR_COMPONENT.js with the name that you've set in output.filename during Step #2
    4. If your component uses any other dependencies, make sure to add them into the peerDependencies list.
  4. Building your component by running npm build in your command line. This would generate the folder /lib which includes your component.

  5. Publishing to npm

    1. Make sure you've registered an npm account
    2. Run npm login in your command line, and enter your credentials.
    3. Run npm publish, and your React component will be uploaded to npm! You can find it at https://www.npmjs.com/package/[YOUR PACKAGE NAME] or your npm profile.
  6. To update your package, make sure you remember to increment the version in package.json, and then perform Step #5 again.