{"id":15866101,"url":"https://github.com/brunoquaresma/dashboardify","last_synced_at":"2025-03-16T01:33:11.087Z","repository":{"id":44099091,"uuid":"461251263","full_name":"BrunoQuaresma/dashboardify","owner":"BrunoQuaresma","description":"Dashboardify Web App","archived":false,"fork":false,"pushed_at":"2022-03-02T23:04:08.000Z","size":350,"stargazers_count":5,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-02-27T04:46:33.684Z","etag":null,"topics":["dashboard","json"],"latest_commit_sha":null,"homepage":"https://dashboardify.app","language":"TypeScript","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/BrunoQuaresma.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}},"created_at":"2022-02-19T16:41:40.000Z","updated_at":"2023-05-30T00:53:07.000Z","dependencies_parsed_at":"2022-09-19T04:41:54.924Z","dependency_job_id":null,"html_url":"https://github.com/BrunoQuaresma/dashboardify","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/BrunoQuaresma%2Fdashboardify","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrunoQuaresma%2Fdashboardify/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrunoQuaresma%2Fdashboardify/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrunoQuaresma%2Fdashboardify/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BrunoQuaresma","download_url":"https://codeload.github.com/BrunoQuaresma/dashboardify/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243801635,"owners_count":20350107,"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","json"],"created_at":"2024-10-05T23:04:00.197Z","updated_at":"2025-03-16T01:33:10.791Z","avatar_url":"https://github.com/BrunoQuaresma.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dashboardify\n\nCreate dashboards using JSON providing a simple JSON schema to create a dashboard that can be shared with your team, company or users.\n## Creating a dashboard using JSON\n\nDashboardify lets you create dashboards using a JSON you provide via a URL. This JSON needs to be formatted in a specific way as shown below:\n\n```json\n{\n  \"sections\": [\n    {\n      \"title\": \"Users\",\n      \"stats\": [\n        {\n          \"label\": \"Total\",\n          \"value\": 1540\n        },\n        {\n          \"label\": \"Today\",\n          \"value\": 20\n        },\n        {\n          \"label\": \"Pro Users\",\n          \"value\": 125\n        }\n      ]\n    },\n    {\n      \"title\": \"Revenue\",\n      \"stats\": [\n        {\n          \"label\": \"Total\",\n          \"value\": 8654,\n          \"prefix\": \"$\"\n        },\n        {\n          \"label\": \"This month\",\n          \"value\": 804.5,\n          \"prefix\": \"$\"\n        },\n        {\n          \"label\": \"MRR\",\n          \"value\": 968.43,\n          \"prefix\": \"$\"\n        }\n      ]\n    },\n    {\n      \"title\": \"Requests\",\n      \"table\": {\n        \"columns\": [\n          \"User\",\n          \"Number of requests\"\n        ],\n        \"data\": [\n          [\n            \"bruno@hotmail.com\",\n            3450\n          ],\n          [\n            \"joao@hotmail.com\",\n            2789\n          ],\n          [\n            \"neto@hotmail.com\",\n            2379\n          ],\n          [\n            \"pedro@hotmail.com\",\n            1045\n          ],\n          [\n            \"jr@hotmail.com\",\n            875\n          ],\n          [\n            \"beto@hotmail.com\",\n            294\n          ]\n        ]\n      }\n    }\n  ]\n}\n```\n\nAs you can see, the dashboard is made up of sections that can have stats, table and a chart. To see the dashboard generated by this example, you can go to the dashboard page.\n\n### Schema\nTo start the schema, you must define the sections you want to show.\n\n| ATTRIBUTE | TYPE                         | REQUIRED |\n|-----------|------------------------------|----------|\n| sections  | Array of [Section](#Section) | Yes      |\n\n### Section\nSections are how Dashboardify groups information. You can have everything in the same section or create different ones for each context, like \"Users\", \"Recipe\", \"Requests\", etc.\n\n| ATTRIBUTE | TYPE                         | REQUIRED |\n|-----------|------------------------------|----------|\n| title     | String                       | Yes      |\n| stats     | Array of [Stat](#Stat)       | No       |\n| table     | [Table](#Table)              | No       |\n| chart     | [Chart](#Chart)              | No       |\n\n### Stat\n\nA stat is used to display numbers as metrics and monetary values.\n\n\n| ATTRIBUTE | TYPE                         | REQUIRED |\n|-----------|------------------------------|----------|\n| label     | String                       | Yes      |\n| value     | Number                       | Yes      |\n| prefix    | String                       | No       |\n\n### Table\n\nA table is used to display tabular data. It's useful when you have a list of values you want to see at once.\n\n| ATTRIBUTE | TYPE                               | REQUIRED |\n|-----------|------------------------------------|----------|\n| columns   | Array of String                    | Yes      |\n| data      | Array of Array of String or Number | Yes      |\n\n### Chart\n\nDisplay a line chart with x and y defined values.\n\n| ATTRIBUTE | TYPE                               | REQUIRED |\n|-----------|------------------------------------|----------|\n| label     | String                             | Yes      |\n| type      | \"linear\"                           | Yes      |\n| lines     | Array of [Line](#Chart-line)      | Yes      |\n\n#### Chart line\n\n| ATTRIBUTE | TYPE                               | REQUIRED |\n|-----------|------------------------------------|----------|\n| id        | String                             | Yes      |\n| color     | String                             | Yes      |\n| data      | Array of [Values](#Chart-values)   | Yes      |\n\n#### Chart values\n\n| ATTRIBUTE | TYPE                               | REQUIRED |\n|-----------|------------------------------------|----------|\n| x         | String                             | Yes      |\n| y         | Number                             | Yes      |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrunoquaresma%2Fdashboardify","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrunoquaresma%2Fdashboardify","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrunoquaresma%2Fdashboardify/lists"}