{"id":19380850,"url":"https://github.com/module-federation/federation-dashboard","last_synced_at":"2025-04-23T20:31:48.160Z","repository":{"id":148303790,"uuid":"262885137","full_name":"module-federation/federation-dashboard","owner":"module-federation","description":"Dashboard service to command, control, and visualize module federation based systems","archived":false,"fork":false,"pushed_at":"2024-03-26T20:00:19.000Z","size":29296,"stargazers_count":20,"open_issues_count":22,"forks_count":6,"subscribers_count":9,"default_branch":"master","last_synced_at":"2025-04-22T02:28:17.063Z","etag":null,"topics":["dashboard","federation","module"],"latest_commit_sha":null,"homepage":"federation-dashboard-alpha.vercel.app","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/module-federation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","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}},"created_at":"2020-05-10T22:15:02.000Z","updated_at":"2025-02-24T12:15:09.000Z","dependencies_parsed_at":"2023-10-14T23:48:45.389Z","dependency_job_id":"37176da3-ebae-410e-9bef-54232dd16bc2","html_url":"https://github.com/module-federation/federation-dashboard","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/module-federation%2Ffederation-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/module-federation%2Ffederation-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/module-federation%2Ffederation-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/module-federation%2Ffederation-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/module-federation","download_url":"https://codeload.github.com/module-federation/federation-dashboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250509654,"owners_count":21442469,"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":["dashboard","federation","module"],"created_at":"2024-11-10T09:14:59.331Z","updated_at":"2025-04-23T20:31:46.558Z","avatar_url":"https://github.com/module-federation.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Medusa\n\nThe Module Federation dashboard takes visualizes the relationships between applications that expose and consume federatd modules.\n\n# What is Medusa??\n\n\u003ca href=\"https://youtu.be/JkOvNPMo7Os\" target=\"_blank\"\u003e\u003cp\u003eclick here to watch\u003c/p\u003e \u003cimg width=\"50%\" src=\"http://i3.ytimg.com/vi/JkOvNPMo7Os/maxresdefault.jpg\"/\u003e\u003ca\u003e\n\n# Installation and startup\n\nTrying it out on the test data\n\nStep 1:\n\n```shell script\n\u003e yarn install\n```\n\nStep 2:\n\n```shell script\n\u003e cd dashboard-fe\n\u003e yarn build \u0026\u0026 yarn start\n```\n\nStep 3:\n\n```shell script\n\u003e cd dashboard-example\n\u003e yarn build \u0026\u0026 yarn serve\n```\n\n# Trying it out on your own code\n\nGlobally install and launch the dashboard:\n\n```shell script\n\u003e npm install -g @module-federation/dashboard-plugin\n\u003e mfdash\n```\n\nThe dashboard will be available on [http://localhost:3000/](http://localhost:3000/).\n\nIn your project, first install the dashboard plugin.\n\n```shell script\n\u003e yarn add @module-federation/dashboard-plugin -D\n```\n\nIn your `webpack.config.js` import the dashboard plugin.\n\n```js\nconst DashboardPlugin = require(\"@module-federation/dashboard-plugin\");\n```\n\nAnd add the plugin to the `plugins` array and alter the parameters to suit.\n\n```js\nnew DashboardPlugin({\n  filename: \"dashboard.json\",\n  dashboardURL: \"http://localhost:3333/update\",\n  metadata: {\n    baseUrl: \"http://localhost:3002\",\n    source: {\n      url: \"https://github.com/module-federation/federation-dashboard/tree/master/dashboard-example/dsl\",\n    },\n    remote: \"http://localhost:3002/remoteEntry.js\",\n  },\n});\n```\n\nNeither `filename` nor `dashboardURL` are required. It's up to you how and when to invoke this plugin and how to store that data and send it to the dashboard. The `/update` endpoint just takes a JSON payload 'as-is'. To post the `dashboard.json` data manually use a `curl` request like this:\n\n```shell script\n\u003e curl \"http://localhost:3333/update\" -X POST \\\n  -d @dashboard-example/utils/dist/dashboard.json \\\n  -H \"Content-type: application/json\"\n```\n\nMetadata isn't required, but it does make the experience better. For example, the `source` URL is used to provide clickable file links in some views. And the `remote` is used when providing information on how to consume the modules provided by\n\nYou should be able to see your application listed. You are _not_ required to have all your federated applicatons listed in the dashboard. But if application A depends on application B, and A is in the dashboard, but B is not, then you will not see references to B because the dashboard doesn't have that data. So you should do your best to get all the applications data into the dashboard.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodule-federation%2Ffederation-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmodule-federation%2Ffederation-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmodule-federation%2Ffederation-dashboard/lists"}