{"id":14563672,"url":"https://github.com/pimcore/studio-ui-bundle","last_synced_at":"2025-05-12T04:30:53.752Z","repository":{"id":240896011,"uuid":"744490935","full_name":"pimcore/studio-ui-bundle","owner":"pimcore","description":"Studio UI bundle","archived":false,"fork":false,"pushed_at":"2025-05-05T08:38:50.000Z","size":251090,"stargazers_count":22,"open_issues_count":156,"forks_count":8,"subscribers_count":12,"default_branch":"1.x","last_synced_at":"2025-05-05T09:35:16.631Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/pimcore.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-01-17T12:09:28.000Z","updated_at":"2025-05-05T08:38:54.000Z","dependencies_parsed_at":"2025-04-24T01:33:55.594Z","dependency_job_id":null,"html_url":"https://github.com/pimcore/studio-ui-bundle","commit_stats":null,"previous_names":["pimcore/studio-ui-bundle"],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pimcore%2Fstudio-ui-bundle","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pimcore%2Fstudio-ui-bundle/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pimcore%2Fstudio-ui-bundle/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pimcore%2Fstudio-ui-bundle/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pimcore","download_url":"https://codeload.github.com/pimcore/studio-ui-bundle/tar.gz/refs/heads/1.x","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253675111,"owners_count":21945900,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-07T02:04:19.879Z","updated_at":"2025-05-12T04:30:48.741Z","avatar_url":"https://github.com/pimcore.png","language":"TypeScript","readme":"# Studio UI\n\nThe Studio UI Bundle provides a Backend UI for Pimcore. It is based on the [React](https://react.dev/) framework.\n\n#### Admin UI: `{your-domain}/pimcore-studio`\n\n#### Storybook: `{your-domain/storybook}`\n\n## How to install\n\n- [Installation](./doc/01_Installation.md)\n\n## How to open\n\nAccess it under `{your-domain}/pimcore-studio`\n\n#### Run the UI under a different URL\n\nTo change the URL you can add the following configuration:\n\n´´´yaml\npimcore_studio_ui:\n    url_path: '/my-backend'\n´´´\n\nStudio will be now accessible under `{your-domain}/my-backend`.\n\n## Development\n\n### How to install\n\n1. Navigate to the plugin directory.\n2. Change to the assets directory `cd ./assets`\n3. Install dependencies `npm install`\n\n### How to build\n\nCreate a new build by running:\n\n`npm run build`\n\n### How to run the dev-server (HMR/Live reloading)\n\n#### Pimcore config\n\nEnable your local domains in terms of CSP (Content-Security-Policy) in the Pimcore config file (`./config/config.yml`)\n\n```\npimcore_admin:\n    admin_csp_header:\n        enabled: true\n        additional_urls:\n            connect-src:\n                - 'ws://localhost:3030'\n                - 'ws://localhost:3031'\n                - 'http://localhost:3030'\n                - 'http://localhost:3031'\n            script-src: \n                - 'http://localhost:3030'\n                - 'http://localhost:3031'\n            font-src:\n                - 'http://localhost:3030'\n                - 'http://localhost:3031'\n            style-src:\n                - 'http://localhost:3030'\n                - 'http://localhost:3031'  \n```\n\n#### How to run and access the dev-server\n\nUse the following command to run the dev-server:\n\n`npm run dev-server`\n\nNow your dev-server should be running (the dev server started on the same URL, but it’s using Webpack HMR).  \nYou can access it under your normal project domain: \n\n`{your-domain}/pimcore-studio`\n\n### Storybook\n\nPimcore studio is using [Storybook](https://storybook.js.org/) for documentation of React components.\n\n#### Commands\n\n```\nnpm run storybook // run storybook with live reloading\nnpm run build-storybook // for building storybook for a static hosting\n```\n\n#### Docker environment\n\nTo use Storybook in your local environment ensure that you open up port `6006`\n\n```\nnode:\n  ports: \n    - \"6006:6006\"\n  ...\n```\n\n#### Nginx configuration\n\nYou should take care of the following configuration:\n\n```\nserver {\n  location ^~ /storybook/ {\n      proxy_pass http://node:6006/;\n  }\n\n  location ^~ /__webpack_hmr {\n      proxy_pass http://node:6006/__webpack_hmr;\n  }\n}\n```\n\nNow ensure that Storybook is running via `npm run storybook`.\nFinally, you can access it under `{your-domain/storybook}`\n\n## Documentation Overview\n\n- [Installation](./doc/01_Installation.md)\n- [Getting started with your first plugin](./doc/05_Plugins/README.md)\n- [SDK Overview](./doc/07_SDK_Overview/README.md)\n","funding_links":[],"categories":["others"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpimcore%2Fstudio-ui-bundle","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpimcore%2Fstudio-ui-bundle","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpimcore%2Fstudio-ui-bundle/lists"}