Skip to content

Commit

Permalink
Update README.md (#543)
Browse files Browse the repository at this point in the history
* Update README.md

* Automatic frontend build

* Delete redundant information in README.md

* Automatic frontend build

---------

Co-authored-by: ValeriaMaltseva <[email protected]>
  • Loading branch information
ValeriaMaltseva and ValeriaMaltseva authored Sep 23, 2024
1 parent c87063c commit 77a4690
Show file tree
Hide file tree
Showing 19 changed files with 1,582 additions and 9 deletions.
21 changes: 12 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,18 @@
# Studio Ui
# Studio UI

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

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

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

## How to install

- [Installation](./doc/01_Installation.md)

## How to open

- Login via the classic backend UI
- Access it under `{your-domain}/pimcore-studio`
Access it under `{your-domain}/pimcore-studio`

#### Run the UI under a different URL

Expand Down Expand Up @@ -69,14 +72,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 +90,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 +115,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
2 changes: 2 additions & 0 deletions public/build/29032939-c160-4adc-bf01-99bc86b1554b/105.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*!
*
* /**
* * Pimcore
* *
* * This source file is available under two different licenses:
* * - Pimcore Open Core License (POCL)
* * - Pimcore Commercial License (PCL)
* * Full copyright and license information is available in
* * LICENSE.md which is distributed with this source code.
* *
* * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* * @license https://github.com/pimcore/studio-ui-bundle/blob/1.x/LICENSE.md POCL and PCL
* * /
*
*/
16 changes: 16 additions & 0 deletions public/build/29032939-c160-4adc-bf01-99bc86b1554b/core-dll.css

Large diffs are not rendered by default.

2 changes: 2 additions & 0 deletions public/build/29032939-c160-4adc-bf01-99bc86b1554b/core-dll.js

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
/*!
Copyright (c) 2018 Jed Watson.
Licensed under the MIT License (MIT), see
http://jedwatson.github.io/classnames
*/

/*!
*
* /**
* * Pimcore
* *
* * This source file is available under two different licenses:
* * - Pimcore Open Core License (POCL)
* * - Pimcore Commercial License (PCL)
* * Full copyright and license information is available in
* * LICENSE.md which is distributed with this source code.
* *
* * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* * @license https://github.com/pimcore/studio-ui-bundle/blob/1.x/LICENSE.md POCL and PCL
* * /
*
*/

/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */

/**
* react-table
*
* Copyright (c) TanStack
*
* This source code is licensed under the MIT license found in the
* LICENSE.md file in the root directory of this source tree.
*
* @license MIT
*/

/**
* table-core
*
* Copyright (c) TanStack
*
* This source code is licensed under the MIT license found in the
* LICENSE.md file in the root directory of this source tree.
*
* @license MIT
*/

/**
* @license React
* react-is.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* react-jsx-runtime.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @license React
* use-sync-external-store-with-selector.production.min.js
*
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

/**
* @remix-run/router v1.16.1
*
* Copyright (c) Remix Software Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE.md file in the root directory of this source tree.
*
* @license MIT
*/

/**
* React Router DOM v6.23.1
*
* Copyright (c) Remix Software Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE.md file in the root directory of this source tree.
*
* @license MIT
*/

/**
* React Router v6.23.1
*
* Copyright (c) Remix Software Inc.
*
* This source code is licensed under the MIT license found in the
* LICENSE.md file in the root directory of this source tree.
*
* @license MIT
*/

/**
* Pimcore
*
* This source file is available under two different licenses:
* - Pimcore Open Core License (POCL)
* - Pimcore Commercial License (PCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license https://github.com/pimcore/studio-ui-bundle/blob/1.x/LICENSE.md POCL and PCL
*/
12 changes: 12 additions & 0 deletions public/build/29032939-c160-4adc-bf01-99bc86b1554b/entrypoints.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
{
"entrypoints": {
"core-dll": {
"css": [
"/bundles/pimcorestudioui/build/29032939-c160-4adc-bf01-99bc86b1554b/core-dll.css"
],
"js": [
"/bundles/pimcorestudioui/build/29032939-c160-4adc-bf01-99bc86b1554b/core-dll.js"
]
}
}
}
Binary file not shown.
Binary file not shown.
Binary file not shown.
Loading

0 comments on commit 77a4690

Please sign in to comment.