Skip to content

Commit

Permalink
fix: update storybook section
Browse files Browse the repository at this point in the history
  • Loading branch information
bonanaaaaaa committed Apr 23, 2024
1 parent 2239497 commit 9781c54
Showing 1 changed file with 34 additions and 5 deletions.
39 changes: 34 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,42 @@ Ref: https://pnpm.io/installation#using-corepack

## Running Storybook (Optional)

To run Storybook and view the UI components in isolation, use the following command:
To run Storybook and view the UI components in isolation, follow these steps:

```
pnpm run storybook
```
1. Clone the Amity UI-Kit repository:

```
git clone https://github.com/AmityCo/Amity-Social-Cloud-UIKit-Web-OpenSource.git
```

2. Navigate to the cloned repository's directory:

```
cd Amity-Social-Cloud-UIKit-Web-OpenSource
```

3. Install the dependencies using pnpm:

```
pnpm install
```

4. Create a `.env` file at the root of the project with the following content:

```
STORYBOOK_API_REGION=<API_REGION>
STORYBOOK_API_KEY=<API_KEY>
```

Replace `<API_REGION>` and `<API_KEY>` with your actual credentials.

5. Run Storybook:

```
pnpm run storybook
```

Then, open your browser and navigate to http://localhost:6006.
6. Open your browser and navigate to `http://localhost:6006` to view the Storybook interface.

## Installation

Expand Down

0 comments on commit 9781c54

Please sign in to comment.