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

react-library-boilerplate-for-npm

v1.0.5

Published

Boilerplate for creating a React + Typescript component library, with Rollup configs set.

Downloads

3

Readme

Your React + Typescript Component Library

This is a boilerplate for creating a React + Typescript component library for upload to NPM, with Rollup configurations set.

Getting Started

To begin using this component library, follow these steps:

1. Fork the Repository: Start by forking this repository to your own GitHub account.

2. Clone the Repository: Clone the forked repository to your local machine using the following command:


git clone [your repository]

3. Make the repository yours: Open the cloned repository on your machine, head to the package.json file and change the "name", "version", and "description" to your desired values. Delete the "repository" field. Delete the /dist folder if you do not need it.

4. Install Dependencies: Navigate to the cloned repository's folder and install the required dependencies:


cd [your cloned repository]

npm install

5. Component Structure: Your components should be placed in the src/components folder. Export each component from its respective file (it will be easier if you stick with named exports).

6. Leave src/globals.d.ts unchanged

7. Export Components: In the src/index.ts file, export each component again. Again, I highly suggest you do named exports to prevent multiple default exports. Refer to the existing src/index.ts file for guidance.

8. Build the dist folder: Run this command to compile your /dist folder


npm run build-lib

9. Login to NPM via terminal if you are not logged in


npm login

10. Publish to NPM: Publish to NPM


npm publish

Contributing

Contributions are welcome! If you'd like to contribute to the project, feel free to fork the repository and submit a pull request.

License

This project is licensed under the MIT License.

Keywords

  • React

  • Typescript

  • Component

  • Library

  • Rollup

  • Boilerplate