This pull request includes significant updates to the project, including the addition of Storybook configuration, example setup, and updates to documentation and configuration files. The most important changes are grouped by theme below:
Storybook Configuration:
Added Storybook configuration in .storybook/main.js to include stories and essential addons. (.storybook/main.js)
Configured global parameters for Storybook in .storybook/preview.js to automatically match actions. (.storybook/preview.js)
Example Setup:
Added an example setup including index.html, index.tsx, package.json, and tsconfig.json files to demonstrate the usage of the library. (example/index.html, example/index.tsx, example/package.json, example/tsconfig.json) [1][2][3][4]
Created a .npmignore file to exclude unnecessary files from the example package. (example/.npmignore)
Documentation and Configuration:
Updated README.md with comprehensive documentation for setting up and using the project, including commands, configuration, and deployment instructions. (README.md)
Updated LICENSE file to reflect the correct copyright information. (LICENSE)
Added project-specific settings to .vscode/settings.json for spell checking. (.vscode/settings.json)
Project Initialization:
Added initial project configuration in package.json including dependencies, scripts, and settings for linting, testing, and building the project. (package.json)
Component and Stories:
Created a Thing component in src/index.tsx and added corresponding Storybook stories in stories/Thing.stories.tsx. (src/index.tsx, stories/Thing.stories.tsx) [1][2]
Added a basic test for the Thing component. (test/blah.test.tsx)
This pull request includes significant updates to the project, including the addition of Storybook configuration, example setup, and updates to documentation and configuration files. The most important changes are grouped by theme below:
Storybook Configuration:
.storybook/main.jsto include stories and essential addons. (.storybook/main.js).storybook/preview.jsto automatically match actions. (.storybook/preview.js)Example Setup:
index.html,index.tsx,package.json, andtsconfig.jsonfiles to demonstrate the usage of the library. (example/index.html,example/index.tsx,example/package.json,example/tsconfig.json) [1] [2] [3] [4].npmignorefile to exclude unnecessary files from the example package. (example/.npmignore)Documentation and Configuration:
README.mdwith comprehensive documentation for setting up and using the project, including commands, configuration, and deployment instructions. (README.md)LICENSEfile to reflect the correct copyright information. (LICENSE).vscode/settings.jsonfor spell checking. (.vscode/settings.json)Project Initialization:
package.jsonincluding dependencies, scripts, and settings for linting, testing, and building the project. (package.json)Component and Stories:
Thingcomponent insrc/index.tsxand added corresponding Storybook stories instories/Thing.stories.tsx. (src/index.tsx,stories/Thing.stories.tsx) [1] [2]Thingcomponent. (test/blah.test.tsx)