Skip to content

A tutorial for creating a React component library using Storybook and TypeScript

upnotes-io/my-awesome-component-library

 
 

Repository files navigation

This is a template to develop and release a react component. This also includes github action for releasing the npm module.

Storybook https://upnotes-io.github.io/my-awesome-component-library/

image

Step to release the npm module

  1. Create a new account in npm. https://www.npmjs.com/signup
  2. Create a new access token and select publish as a type https://www.npmjs.com/settings/upnotes/tokens
  3. Add secret to your repo or organization as NPM_TOKEN https://github.com/organizations/upnotes-io/settings/secrets/actions/new
  4. Create a new tag and use that tag to create the release. Creating a new release will trigger the workflow.

Publishing to github pages:

Adding deploy keys to your repo:

  1. https://github.com/JamesIves/github-pages-deploy-action/tree/dev#using-an-ssh-deploy-key-
  2. https://docs.github.com/en/developers/overview/managing-deploy-keys#setup-2

Used by

  1. https://github.com/upnotes-io/react-todo - A generic todo list component for react. This is being used in an electron based app: https://upnotes.io

Please create a PR if you are using this template in your open source project.

About

A tutorial for creating a React component library using Storybook and TypeScript

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 53.5%
  • JavaScript 28.4%
  • CSS 18.1%