Moon Package Starter

Photo by: https://www.ign.com/ - Game of Elden Ring

Starter boilerplate for developing React packages.

Development 🧑🏻‍💻

Run storybook 📚

npm run storybook
# or
yarn run storybook
# or
pnpm storybook

Run tests 🧪

For unit tests:

npm run test
# or
yarn test
# or
pnpm test

for running unit tests in watch mode:

npm run test:watch
# or
yarn test:watch
# or
pnpm test:watch

Run Lint 🥸

npm run lint
# or
yarn run lint
# or
pnpm lint

Run Prettier 🧹

npm run format
# or
yarn run format
# or
pnpm format

Build 🗜️

npm run build
# or
yarn run build
# or
pnpm build

Tools and Setup in this project: 🧰

• React
• Rollup: The JavaScript module bundler
• Prettier: Code formatter
• Eslint: Code Linter
• TypeScript
• Storybook: Storybook is a frontend workshop for building UI components and pages in isolation. Thousands of teams use it for UI development, testing, and documentation.
• Jest: Run unit tests.
• Testing library: Simple and complete testing utilities that encourage good testing practices.

Learn More 📚

To learn more about setup, and this project, take a look at the following resources:

• How to build a component library with React and TypeScript
• Building Efficient npm Packages with React, TypeScript, and CSS Modules: A Comprehensive Guide
• How to Create and Publish React TypeScript npm Package With Demo and Automated Build
• Husky and lint-staged for pre-commit in React
• Rollup Config for React Component Library With TypeScript + SCSS