Moonchaeyeon/react-library-template

library template for react

React Library Template

This is library template with ReactJS v18, storybook v7, Typescript, SCSS, Rollup.js.

Guide

🧩 Make Your Library Project with this template

Click Use this template button to create new repository using this template

Then clone that repository locally

git clone "[github url using this template]"

⚙️ Set Library Info

You can change library information in package.json

{
	"name": "[library name]",
	"author": {
		"name": "[your name]",
		"email": "[your email]"
	},
	"version": "[library version]",
}

☕️ Install Packages

Install related packages.

yarn

🛍 Customize Your Library

• working directory : ./src
• export your components, functions, etc. from ./src/index.ts

🧪 Test Your Library

You can test your UI components with Storybook

yarn storybook

🔨 Build

Build your library with Rollup.js.

yarn build

• Your library build file will generate on ./dist

🎉 Publish Your Library to NPM

npm login
yarn publish --access public

• Login with your npm account
  • to create a new account 👉 https://www.npmjs.com/
• Publish your library
  • When publishing for the first time, the access property must be set to public.
  • The next publication should always be a higher version than the previous publication.