{"id":15604452,"url":"https://github.com/mohnish/dashboard","last_synced_at":"2025-09-03T08:14:34.330Z","repository":{"id":143229093,"uuid":"220723746","full_name":"mohnish/dashboard","owner":"mohnish","description":"A simple and extensible dashboard to display data that matters to you","archived":false,"fork":false,"pushed_at":"2024-10-27T23:07:04.000Z","size":48,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-27T02:46:19.081Z","etag":null,"topics":["dashboard","golang","plug-ins","poll","push","real-time","webhooks"],"latest_commit_sha":null,"homepage":"https://iam.mt/dashboard/","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mohnish.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2019-11-10T00:58:46.000Z","updated_at":"2025-01-20T00:58:14.000Z","dependencies_parsed_at":"2024-12-06T21:57:45.631Z","dependency_job_id":"5b72466e-21d0-4a1e-a1d1-d5c1bd7f98d8","html_url":"https://github.com/mohnish/dashboard","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/mohnish/dashboard","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohnish%2Fdashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohnish%2Fdashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohnish%2Fdashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohnish%2Fdashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mohnish","download_url":"https://codeload.github.com/mohnish/dashboard/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mohnish%2Fdashboard/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273410529,"owners_count":25100538,"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-09-03T02:00:09.631Z","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":["dashboard","golang","plug-ins","poll","push","real-time","webhooks"],"created_at":"2024-10-03T03:41:28.041Z","updated_at":"2025-09-03T08:14:34.303Z","avatar_url":"https://github.com/mohnish.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dashboard\n\n\u003e A simple and extensible dashboard to display data that matters to you\n\n**NOTE: Project is under active development - switched default branch from `master` to `main`**\n\nDashboard is designed to allow developers to build widgets by writing plug-ins. Dashboard supports plug-ins written in JSON out-of-the-box. Support for other technologies such as TOML, YAML etc will be added in the future. The goal is to allow developers to develop their own custom plug-ins which can be shared among the members of the Dashboard community. The project is actively being developed\n\n![](https://i.imgur.com/xHb0goi.png)\n\n\n## Getting Started\n\n* [TODO] Hosting\n* Push data to `/push` endpoint\n\n## Installation\n\n* [TODO] Deploy Dashboard server\n\n## Features\n\n* Push support\n* Pull support\n* Extensible via plug-ins\n* Shareable plug-ins\n* [TODO] Map response values to display in Dashboard\n* [TODO] Category support\n* [TODO] Response Hooks\n\n## Development\n\nFor convenience, a `Makefile` is setup. From the app root, running the `make` command will build and run the go program.\n\nIf you want to run the commands manually, run `go build` from the app root. Once everything is built, run `PORT=300 ./dashboard` from the app root. You should be able to access Dashboard at [http://localhost:3000](http://localhost:3000). PLug-ins can be written and tested out locally.\n\n## Tests\n\nRun `go test`\n\n## Technology\n\nDashboard is built on the following stack:\n\n* Back-end: Go\n* Front-end: React [TODO]\n\n## Plug-ins\n\nA Dashboard Plug-in is a simple config file stores details on how to access a particular endpoint and which parts of the response are required. This can be written by anyone to access any data that they'd like to display using Dashboard.\n\nFollowing are the supported fields\n\n- `id`: unique identifier to identify the plug-in\n- `name`: display name of the component in the UI\n- `url`: endpoint that dashboard needs to poll\n- `method` (optional. default is `GET`): restful verb that needs to be used to query the endpoint [GET/POST]\n- `headers` (optional): headers that need to be passed in for the request\n- `interval` (optional. default is `10` seconds): polling interval\n\nHere's an example:\n\n```json\n{\n  \"id\": \"unique-id\",\n  \"name\": \"Server Uptime\",\n  \"method\": \"GET\",\n  \"headers\": {},\n  \"url\": \"http://localhost:3002/data\",\n  \"interval\": \"5\",\n}\n\n```\n\n## Future\n\n* Category/Page Support\n\nGroup components and display them as separate pages. This enables a single Dashboard server to handle multiple subscriptions with the convenience of displaying the components based on categories.\n\n* Filterable Subscription values\n\nCurrently, Dashboard expects a certain structure in the JSON responses of the pull calls. In the future, the plug-in authors will be able to filter and map JSON values from the response.\n\n* Hooks\n\nEach response that Dashboard receives from either a push or a pull, will be parsed and a hook can be run, if configured.\n\nFor example, say we have a poll subscription that checks for the uptime of a particular endpoint. If Dashboard receives a response that's not a 200, it can run the configured hooks. These hooks can either be a message to post to Slack or notify the devs or just pop up a message alerting the people that need to be notified.\n\n* Support for multiple languages\n\nTOML and YAML (partially supported already since JSON is supported)\n\n* Support human readable text in intervals\n\nCurrently, Dashboard only supports integer values to represent the number of seconds. Support for text such as `1m`, `1h`, `1m20s`, `5s` etc will be supported soon.\n\n## Contributing\n\n* [TODO] Add Guidelines here\n\n## License\n\n(The MIT License)\n\nCopyright (c) 2019 Mohnish Thallavajhula \u0026lt;hi@iam.mt\u0026gt;\n\nPermission is hereby granted, free of charge, to any person obtaining\na copy of this software and associated documentation files (the\n'Software'), to deal in the Software without restriction, including\nwithout limitation the rights to use, copy, modify, merge, publish,\ndistribute, sublicense, and/or sell copies of the Software, and to\npermit persons to whom the Software is furnished to do so, subject to\nthe following conditions:\n\nThe above copyright notice and this permission notice shall be\nincluded in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY\nCLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,\nTORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE\nSOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohnish%2Fdashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmohnish%2Fdashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmohnish%2Fdashboard/lists"}