diff --git a/README.md b/README.md index de72c4acf..bd190deec 100644 --- a/README.md +++ b/README.md @@ -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) @@ -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 @@ -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: @@ -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