React Component Library Starter Kit

This template provides a extensive setup to create a component library of React Components.

This template comes with the following technologies configured and ready to go:

• React
• TailwindCSS
• TypeScript
• Vite
• Vitest
• Storybook
• Automated CI testing, linting, formatting and coverage with GitHub Actions
• Release automation with GitHub Actions and publishing to NPM
• GitHub Pages Dashboard with API Docs, Storybooks and Test Coverage
• Automatic Documentation Generation with TypeDoc
• Winston for logging. There is a logging utility that can be used to log to the console

Getting Started

Begin via any of the following:

• Press the "Use this template" button

• Use degit to execute:

  degit github:dream-aim-deliver/dad-ui-components-starter-template

• Use GitHub CLI to execute:

  gh repo create <name> --template="https://github.com/dream-aim-deliver/dad-ui-components-starter-template"

• Simply git clone, delete the existing .git folder, and then:

  git init
  git add -A
  git commit -m "Initial commit"

Customizing the Template

Please go through the following checklist to ensure you have configured the template correctly:

• [ ] Push your code to a new GitHub repository.
• [ ] Update the test coverage thresholds in the vite.config.ts file.
• [ ] Remember to use npm search <term> to avoid naming conflicts in the NPM Registry for your new package name.
• [ ] Update the package.json file with your package name, version, description, author and repository information.
• [ ] Add or update the LICENSE file.
• [ ] In the GitHub repository, go to the "Settings" tab and select "Pages" section. Then select the source as "Github Actions".
• [ ] Generate a new NPM Access Token.
• [ ] Create a secret in the GitHub repository called NPM_TOKEN with the value of the npm access token from the previous step.
• [ ] Update the README.md file by replacing <MY_COMPONENT_LIBRARY> with the name of your component library. Also, please update the href to point to your GitHub Pages URL.
• [ ] Please read and update the Contributing Guidelines before contributing to this project.
• [ ] Please go through the Release Guidelines before releasing a new version of this project.
• [ ] Please make sure your developers have read the Development Guidelines before starting development.
• [ ] Please remember to define the theme of your component library (colors, shades, fonts, animations, breakpoints etc..) in the tailwind.config.js file.
• [ ] Once you have completed the above steps, you can delete the contents of this README.md file from here above. Please add any additional information about your component library at the end of this README. This file is used to generate the homepage for your NPM Package on npmjs.com and is also the homepage for your TypeDoc dashboard.

Your README.md Content goes here:

<MY_COMPONENT_REPOSITORY>