{"id":20128061,"url":"https://github.com/osandadeshan/api-health-checker-dashboard","last_synced_at":"2025-05-06T18:32:02.588Z","repository":{"id":46626709,"uuid":"304352124","full_name":"osandadeshan/api-health-checker-dashboard","owner":"osandadeshan","description":"A node application to show the availability of the backend services in a dashboard.","archived":false,"fork":false,"pushed_at":"2024-04-26T17:06:32.000Z","size":4130,"stargazers_count":23,"open_issues_count":0,"forks_count":18,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-09T15:51:48.246Z","etag":null,"topics":["api","api-health-checker","backend-services","css","dashboard","dashboard-application","health-check","html5","javascript"],"latest_commit_sha":null,"homepage":"https://osandadeshan-api-health-checker-dashboard.glitch.me/","language":"JavaScript","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/osandadeshan.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":"2020-10-15T14:27:56.000Z","updated_at":"2024-12-05T17:51:26.000Z","dependencies_parsed_at":"2024-04-26T18:36:08.912Z","dependency_job_id":null,"html_url":"https://github.com/osandadeshan/api-health-checker-dashboard","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/osandadeshan%2Fapi-health-checker-dashboard","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fapi-health-checker-dashboard/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fapi-health-checker-dashboard/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/osandadeshan%2Fapi-health-checker-dashboard/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/osandadeshan","download_url":"https://codeload.github.com/osandadeshan/api-health-checker-dashboard/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252744551,"owners_count":21797645,"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":["api","api-health-checker","backend-services","css","dashboard","dashboard-application","health-check","html5","javascript"],"created_at":"2024-11-13T20:25:14.799Z","updated_at":"2025-05-06T18:32:01.364Z","avatar_url":"https://github.com/osandadeshan.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# API Health Checker Dashboard\n\n## Introduction\nWhen we are working on a real project, it is vital to have a dashboard where we can find the availability of the backend services integrated with that project.\nThis solution can be used for that purpose.\n\n\u003e Demo App\n![](https://user-images.githubusercontent.com/9147189/135744321-a4f58864-7331-4097-b83c-43edb2940d5a.png)\n\n## Advantages\n* Easy to find unavailable backend services\n* Real-time updating the services' status in every “x” seconds (“x” can be configured. By default, “x” is 30 seconds)\n* Easy to integrate services\n* Can maintain multiple environments\n* No need to worry about the [CORS issue](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS)\n* Both Web and Mobile friendly UI\n* Free and open-source\n\n## Architecture\n\u003e Architecture\n![](https://user-images.githubusercontent.com/9147189/135319309-3a8eda05-dc29-4df0-be03-5b921b17a822.PNG)\n\n## API Health Checker Dashboard Vs Dynatrace Dashboard\n| Criteria | API Health Checker Dashboard | Dynatrace Dashboard |\n| ------------ | ------------ | ------------ |\n| Real-time monitoring | Yes | Minimum interval is 5 minutes |\n| Historical view | Not yet implemented | Yes |\n| Integrating backend services | Only need to update in a single file | Need to create HTTP monitors per service and add it to the dashboard |\n| Managing environments​ | Can maintain multiple environments via multiple json files | Need to create multiple HTTP monitors per each environment and service |\n| Cost | Free and open-source | Paid tool |\n\n## How to use?\n**Pre-requisites:**\n* [Node](https://nodejs.org/en/download/)\n* [VSCode](https://code.visualstudio.com/download)\n\n**Steps:**\n1. Clone this project\n2. Open the project in VSCode\n3. Update the JSON files located in \"***api-health-checker-dashboard/config***\" with your Backend services' health routes\n4. Save the changes\n5. Open a terminal from VSCode\n6. Execute ***`npm install`*** to install the node modules\n7. Execute ***`npm run dev`*** to start the node application\n8. Open the web application from http://localhost:5000\n\n**Note: You won't be facing [CORS issue.](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) Because this application has a proxy layer to solve that issue. You can deploy this application as a node application.**\n\n## Deployment\nYou can deploy this as a node application.\n\n**Sample API Health Checker Dashboard: https://osandadeshan-api-health-checker-dashboard.glitch.me/**\n\n## License\n\u003cimg src=\"https://upload.wikimedia.org/wikipedia/commons/thumb/0/0b/License_icon-mit-2.svg/2000px-License_icon-mit-2.svg.png\" alt=\"MIT License\" width=\"100\" height=\"100\"/\u003e [API Health Checker Dashboard](https://medium.com/api-health-checker) is released under [MIT License](https://opensource.org/licenses/MIT)\n\n## Copyright\nCopyright 2022 [MaxSoft](https://maxsoftlk.github.io/).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosandadeshan%2Fapi-health-checker-dashboard","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fosandadeshan%2Fapi-health-checker-dashboard","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fosandadeshan%2Fapi-health-checker-dashboard/lists"}