{"id":18756491,"url":"https://github.com/octoprint/octoprint-uiprototype","last_synced_at":"2025-11-30T03:30:12.565Z","repository":{"id":154886121,"uuid":"632462979","full_name":"OctoPrint/OctoPrint-UiPrototype","owner":"OctoPrint","description":"Basic Prototype for a Material based UI supporting extension by plugins.","archived":false,"fork":false,"pushed_at":"2023-04-25T13:24:41.000Z","size":66,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-29T02:00:21.797Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OctoPrint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-25T13:09:19.000Z","updated_at":"2023-04-25T13:16:18.000Z","dependencies_parsed_at":"2023-06-12T04:00:39.366Z","dependency_job_id":null,"html_url":"https://github.com/OctoPrint/OctoPrint-UiPrototype","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctoPrint%2FOctoPrint-UiPrototype","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctoPrint%2FOctoPrint-UiPrototype/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctoPrint%2FOctoPrint-UiPrototype/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OctoPrint%2FOctoPrint-UiPrototype/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OctoPrint","download_url":"https://codeload.github.com/OctoPrint/OctoPrint-UiPrototype/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239644124,"owners_count":19673582,"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-11-07T17:36:51.463Z","updated_at":"2025-11-30T03:30:12.498Z","avatar_url":"https://github.com/OctoPrint.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Plugin enabled UI Prototype\n\nBasic Prototype for a Material based UI supporting extension by plugins.\n\nCan be accessed by attaching `?uiprototype` to the OctoPrint URL. Be advised that this is really just a demo of the\nextension concept, it's non functional as an OctoPrint frontend itself.\n\n## Setup\n\nInstall via the bundled [Plugin Manager](https://docs.octoprint.org/en/master/bundledplugins/pluginmanager.html)\nor manually using this URL:\n\n    https://github.com/OctoPrint/OctoPrint-UiPrototype/archive/main.zip\n\n## Implementation details\n\n### OctoPrint plugin\n\nThe OctoPrint plugin is a `UiPlugin` that renders the contents of `index.html.jinja2` when invoked. That page\ntakes care of loading React and MaterialUI as UMD files from the `unpkg.com` CDN, and also loading the frontend\nbundle and binding it to the root DOM node.\n\nAdditional plugins are loaded via the `octoprint.plugin.uiprototype.gather_modules` hook, which needs to return \na dictionary consisting of a global identifier and a JS file to load. See the [test plugin](https://github.com/OctoPrint/OctoPrint-UiPrototype-TestPlugin) \nfor an example of how to do that. The outcome of gathering plugins is made available on the frontend via\n`OCTOPRINT_CONFIG.modules`.\n\n### Frontend\n\nThe frontend source can be found in the `frontend/` directory. There's a bunch of commands available:\n\n- `npm install`: Install deps\n- `npm run watch`: Runs the webpack build that compiles to `dist/` in the plugin folder, watches for file changes\n- `npm run build`: Runs the webpack build that compiles to `dist/` once.\n\nThe initialization code loads info about available plugins from `OCTOPRINT_CONFIG.modules` and registers\nthem with the extension point system.\n\n## Open questions\n\n- [ ] How to make components from the default UI available to plugins?\n- [ ] Component usage by from other plugins? (probably related to ⬆)\n- [ ] Global event bus? (custom context? see first todo)\n- [ ] Global API access? (custom context? see first todo)\n- ...\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctoprint%2Foctoprint-uiprototype","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foctoprint%2Foctoprint-uiprototype","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foctoprint%2Foctoprint-uiprototype/lists"}