Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ValeriaMaltseva committed Sep 19, 2024
1 parent 1d5d1a1 commit d552577
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Studio Ui
# Studio UI

The Studio UI Bundle provides a Backend UI for Pimcore. It is based on the [React](https://react.dev/) framework.

#### Backend Admin Panel: `{your-domain}/admin`

#### Frontend UI: `{your-domain}/pimcore-studio`

#### Storybook: `{your-domain/storybook}`

## How to install

- [Installation](./doc/01_Installation.md)
Expand Down Expand Up @@ -69,14 +75,14 @@ Use the following command to run the dev-server:

`npm run dev-server`

Now your dev-server should be running.
Now your dev-server should be running (the dev server started on the same URL, but it’s using Webpack HMR).
You can access it under your normal project domain:

`{your-domain}/admin/studio`
`{your-domain}/pimcore-studio`

### Storybook

Pimcore studio is using [Storybook](https://storybook.js.org/) for documentation of react components.
Pimcore studio is using [Storybook](https://storybook.js.org/) for documentation of React components.

#### Commands

Expand All @@ -87,7 +93,7 @@ npm run build-storybook // for building storybook for a static hosting

#### Docker environment

To use storybook in your local environment ensure that you open up port `6006`
To use Storybook in your local environment ensure that you open up port `6006`

```
node:
Expand All @@ -112,8 +118,8 @@ server {
}
```

Now ensure that storybook is running via `npm run storybook`.
Finally you can access it under `{your-domain/storybook}`
Now ensure that Storybook is running via `npm run storybook`.
Finally, you can access it under `{your-domain/storybook}`

## Documentation Overview

Expand Down

0 comments on commit d552577

Please sign in to comment.