Skip to content

Commit

Permalink
add storybook to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Excleson committed Oct 12, 2023
1 parent b10ffe4 commit afe6b48
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,8 @@

- Simple form validation with [React Hook Form](https://react-hook-form.com/get-started), designed to be [integrated with Ant Design](https://react-hook-form.com/get-started#IntegratingControlledInputs) and [Zod](https://react-hook-form.com/get-started#SchemaValidation)

- Interactive documentation with [Storybook](https://storybook.js.org/)

- Provide sane defaults for the most common security headers

## Getting Started
Expand All @@ -62,7 +64,7 @@ To display Tailwind CSS IntelliSense in Visual Studio Code, install [the officia

### `components` Folder

Place reusable React components in this folder.
Place reusable React components and Storybook stories in this folder.

It is recommended to develop using [function components](https://reactjs.org/docs/components-and-props.html) with [hooks](https://reactjs.org/docs/hooks-intro.html) instead of class components.

Expand Down Expand Up @@ -91,6 +93,16 @@ Components should be styled with one of these techniques, sorted from the most r

> :warning: Due to the global nature of stylesheets, and to avoid conflicts, they may not be imported from pages / components.
### Making Component's Documentations

Components should be documented by using [Storybook](https://storybook.js.org/) by making a stories for each component.

Run the Storybook with command:

```sh
npm run storybook
```

### `functions` Folder

Place reusable plain JS functions in this folder.
Expand Down

0 comments on commit afe6b48

Please sign in to comment.