{"id":18647635,"url":"https://github.com/artcom/webapp-compositor","last_synced_at":"2025-08-27T04:08:07.527Z","repository":{"id":34843842,"uuid":"113326321","full_name":"artcom/webapp-compositor","owner":"artcom","description":"Composes multiple webapps on layers with different transitions and geometry via an MQTT API","archived":false,"fork":false,"pushed_at":"2025-06-05T13:01:56.000Z","size":2776,"stargazers_count":2,"open_issues_count":3,"forks_count":0,"subscribers_count":12,"default_branch":"master","last_synced_at":"2025-06-05T13:26:11.767Z","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/artcom.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,"zenodo":null}},"created_at":"2017-12-06T14:25:39.000Z","updated_at":"2025-06-05T12:17:07.000Z","dependencies_parsed_at":"2025-05-08T21:59:41.343Z","dependency_job_id":null,"html_url":"https://github.com/artcom/webapp-compositor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/artcom/webapp-compositor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Fwebapp-compositor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Fwebapp-compositor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Fwebapp-compositor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Fwebapp-compositor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/artcom","download_url":"https://codeload.github.com/artcom/webapp-compositor/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/artcom%2Fwebapp-compositor/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272289219,"owners_count":24907797,"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","status":"online","status_checked_at":"2025-08-27T02:00:09.397Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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-07T06:27:14.735Z","updated_at":"2025-08-27T04:08:07.512Z","avatar_url":"https://github.com/artcom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# WebApp Compositor\n\nThe compositor acts as a window manager for webApps on multiple layers with an MQTT API. WebApps can be started with specific enter/exit transitions as well as individual geometry for custom overlay scenarios.\n\nNote: On startup the compositor publishes `${administrationTopic}/doExecuteActionList`: `${deviceTopic}/defaultActions` to setup itself, which has to be defined in the configuration.\n\n## Run\n\n- Run in development: `ADMINISTRATION_TOPIC=\u003cadministration-topic\u003e npm run watch`\n- Start the application: `PORT=5000 ADMINISTRATION_TOPIC=\u003cadministration-topic\u003e npm start`\n\n## API\n\n### devices/\\\u003cdevice\\\u003e/doStartWebApp\n\nThis command starts a web application or website with the given `uri`.\n\n**Payload Format:**\n\n```js\n{\n  uri: String,\n  tour?: String,            // the tour the webApp belongs to, see below\n  layer?: Number,           // positiv layer index, default: 0\n  layerType?: \"iframe\" | \"webview\", // layer type used for the webApp, default: \"iframe\"\n  transition?: \"fade\" | \"fadeToBlack\" | \"scrollLeft\" | \"scrollRight\" | \"scaleRight\" | \"none\", // default: \"fade\"\n  closeButton?: Object {    // Object describing a button to close/stop the webapp, default: undefined\n    uri?: String,           // Uri of webapp or asset, default: undefined (transparent button)\n    left?: String,          // left postion of the closeButton, default: \"90%\"\n    top?: String,           // top postion of the closeButton, default: \"0%\"\n    width?: String,         // width of the closeButton, default: \"10%\"\n    height?: String,        // height of the closeButton, default: \"10%\"\n    actions?: Object | Array // an ActionList (see ActionList Example) to be executed by an action-list-executor, default: undefined\n  },\n  dimBackground?: Boolean,  // adds a fullscreen dimmed background behind the webApp, default: false\n  backgroundColor?: String, // CSS backgroundColor (e.g. \"#fff\") which is visible if the webApp has a transparent background, default: undefined\n  bootstrap?: Boolean,      // defines wether to append bootstrap params to the uri or not, default: true\n  restart?: Boolean,        // defines wether to restart the webApp if the same webApp is already open on the same layer, default: true\n  left?: String,            // left postion of the webApp, default: \"0px\"\n  top?: String,             // top postion of the webApp, default: \"0px\"\n  width?: String,           // width of the webApp, default: \"100%\"\n  height?: String           // height of the webApp, default: \"100%\"\n}\n```\n\n**Payload Example:**\n\n```js\n{\n  uri: \"https://www.wikipedia.org/\",\n  tour: \"my-tour\"\n}\n```\n\n### devices/\\\u003cdevice\\\u003e/doStopWebApp\n\nThis command removes a running web application or websites from the given layer.\n\n**Payload Format:**\n\n```js\n{\n  layer: Number, // positiv layer index\n}\n```\n\n**Payload Example:**\n\n```js\n{\n  layer: 0\n}\n```\n\n### devices/\\\u003cdevice\\\u003e/doReset\n\nThis command resets the entire compositor which removes all running webApps.\n\n**Payload Format:**\n\n```js\nnull\n```\n\n**Payload Example:**\n\n```js\nnull\n```\n\n### \\\u003cadministrationTopic\\\u003e/onTourDelete\n\nThis event removes all running webApps wich have been started with the given tour.\n\n**Payload Format:**\n\n```js\nString\n```\n\n**Payload Example:**\n\n```js\nmyTour\n```\n\n## Tour Context\n\nIf a tour is given on `doStartWebApp` the webApp will receive tour related bootstrap param and will be removed `onTourDelete`.\n\n## Framer-Motion Installation\n\nFramer-motion is installed using build-files from [this fork](https://github.com/artcom/motion) which incorporate this [pull request](https://github.com/framer/motion/pull/1569) from the [official repository](https://github.com/framer/motion). Since it is a mono-repo with subdirectorys, npm installation uses the online service [https://gitpkg.now.sh](https://gitpkg.now.sh), which creates and streams a tarball of the `framer-motion` subdirectory. (See [package.json](package.json#L25))\n\n## Development\n\nDubugging controls ([leva](https://github.com/pmndrs/leva)) can be activated using the URL query parameter `?debug`\n\ne.g. `http://localhost:8080/?wsBrokerUri=ws://localhost:9001\u0026debug`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartcom%2Fwebapp-compositor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fartcom%2Fwebapp-compositor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fartcom%2Fwebapp-compositor/lists"}