{"id":13553878,"url":"https://github.com/data-fair/app-charts","last_synced_at":"2026-01-31T06:30:49.432Z","repository":{"id":43443250,"uuid":"141715658","full_name":"data-fair/app-charts","owner":"data-fair","description":"A simple charting application for data-fair. Also used as an example for the documentation and to bootstrap other applications.","archived":false,"fork":false,"pushed_at":"2025-12-15T17:31:39.000Z","size":2220,"stargazers_count":4,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-19T00:09:04.503Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://koumoul-dev.github.io/data-fair-charts/","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/data-fair.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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-07-20T13:30:16.000Z","updated_at":"2025-12-15T17:31:42.000Z","dependencies_parsed_at":"2024-04-29T17:28:41.204Z","dependency_job_id":"aa9c185c-33a7-44ac-a91e-f8880e1d8765","html_url":"https://github.com/data-fair/app-charts","commit_stats":{"total_commits":126,"total_committers":2,"mean_commits":63.0,"dds":0.05555555555555558,"last_synced_commit":"f090318b0352160b922f3fc85be97869ff8f848e"},"previous_names":["koumoul-dev/data-fair-charts"],"tags_count":86,"template":false,"template_full_name":null,"purl":"pkg:github/data-fair/app-charts","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fapp-charts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fapp-charts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fapp-charts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fapp-charts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/data-fair","download_url":"https://codeload.github.com/data-fair/app-charts/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/data-fair%2Fapp-charts/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28931247,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-31T04:05:25.756Z","status":"ssl_error","status_checked_at":"2026-01-31T04:02:35.005Z","response_time":128,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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-08-01T12:02:35.298Z","updated_at":"2026-01-31T06:30:49.423Z","avatar_url":"https://github.com/data-fair.png","language":"JavaScript","funding_links":[],"categories":["JavaScript","others"],"sub_categories":[],"readme":"# @data-fair/app-charts\n\n![NPM Version](https://img.shields.io/npm/v/%40data-fair%2Fapp-charts) ![NPM Downloads](https://img.shields.io/npm/dt/%40data-fair%2Fapp-charts) ![jsDelivr hits (npm)](https://img.shields.io/jsdelivr/npm/hm/%40data-fair%2Fapp-charts)\n  \nA simple charting application for [DataFair](https://data-fair.github.io/3/). Also used as an [example for the documentation](https://data-fair.github.io/3/interoperate/applications).  \n  \nIt is hosted by [npm](https://www.npmjs.com/package/@data-fair/app-charts) and the [jsdelivr CDN](https://www.jsdelivr.com/package/npm/@data-fair/app-charts).  \n  \nAn example app can be found [here](https://demo.koumoul.com/applications/categories-des-etablissements-par-departements), it uses [this dataset](https://demo.koumoul.com/datasets/etablissements-finess-france).\n\n## Context\n\n[DataFair](https://data-fair.github.io/3/) is an Open Source Web software developped by [Koumoul](https://koumoul.com) for publishing data online with complete search and aggregation capabilities, metadata management, mapping functionalities, access control, etc. It can be used as a back office for Open Data platforms, data visualizations, custom search engines and other applications.  \n  \nDataFair comes with functionalities to facilitate the development, deployment and configuration of small data consuming applications. `app-charts` is an example of such an application.\n\n## Technical stack\n\nThis technical stack is just an example of what can be used to build an application for DataFair. It is a quite rich stack for a state of the art development environment. For an application with a more minimalist stack, you can see [app-minimal](https://github.com/data-fair/app-minimal). For a state of the art application generator see the [vue-cli plugin](https://github.com/data-fair/vue-cli-plugin-app).\n- [vuejs](https://vuejs.org/): our favorite framework for client-side code\n- [vuetify](https://vuetifyjs.com/en/): a material design UI framework for vuejs\n- [chartjs](https://www.chartjs.org/): simple charting library\n\n## Development Setup\n\nStart by downloading, cloning or forking this repository:\n\n```bash\ngit clone https://github.com/data-fair/app-charts.git\ncd app-charts\n```\n\nInstall nodejs dependencies for the development environment:\n\n```bash\nnpm install\n```\n\n#### If you are running a local data-fair instance\n\nCreate a dataset in your data-fair instance. You can use this [public dataset](https://koumoul.com/s/data-fair/dataset/population-communes/description) for example.  \n  \nRun the development server and serve the application with hot reload [here](http://localhost:3000):\n\n```bash\nnpm run dev-src\n```\n\nYou can now add an application configuration pointing to http://localhost:3000 in your data-fair instance. Edit the configuration, edit the source code, etc.  \n\n#### Else\n\nRun the development server and serve the application with hot reload [here](http://localhost:3000):\n\n```bash\nnpm run dev\n```\n\nYou will find a dev server running at http://localhost:5888. It contains sample data and a sample configuration. You can edit the source code, edit the configuration, etc.\n\n## DataFair application specificity\n\nA DataFair application is mostly like any Web application. You can consume DataFair APIs from any framework for example. But for a seamless integration and multi-configuration management by DataFair you need to respect a few conventions. The following sections are a focus on the files that implement these conventions.\n\n#### `public/config-schema.json`\n\nA JSON schema file that describes the expected configuration. DataFair expects this file to be found at the precise path `%MY_APP%/config-schema.json`.\n\nThe content of this JSON schema is extended with some annotations used by DataFair to automatically create a configuration form. The details of these annotations can be found in demo of the library we maintain to create these forms:  [vuetify-jsonschema-form](https://github.com/koumoul-dev/vuetify-jsonschema-form).\n\n#### `index.html`\n\nThis the root template used to generate the HTML pages of this application. The key element here is this line:\n\n```html\n\u003cscript type=\"text/javascript\"\u003ewindow.APPLICATION=%APPLICATION%;\u003c/script\u003e\n```\n\nThe string `%APPLICATION%` will be replaced automatically by the actual content of the configuration, when this application is re-exposed by DataFair. Later code can use the global variable `APPLICATION` (`window.APPLICATION`) to start interacting with the DataFair API.  \nThe important part for DataFair is the presence of the meta properties \"title\" and \"description\".\n\n## Deployment\n\nTo publish the project, upload it to the global npm registry (you need to be a member of the owner organization).\n\n```bash\nnpm version PATCH|MINOR|MAJOR\nnpm publish\ngit push \u0026\u0026 git push --tags\n```\n\nIf the release is a bug fix and you don't want to wait 24h (the cache delay of jsdelivr), you can purge the cache for the index.html file of the minor version in the CDN:\n\n```bash\ncurl https://purge.jsdelivr.net/npm/@data-fair/app-charts@VER/dist/index.html\n```\n\nReplace `VER` with the minor version number (e.g. `1.0`).  \n  \nTo publish a version for testing purposes you can tag it as a pre-release and publish it with the tag \"staging\".\n\n```bash\nnpm version prerelease --preid=staging\nnpm publish --tag staging\ncurl https://purge.jsdelivr.net/npm/@data-fair/app-charts@staging/dist/index.html\ngit push \u0026\u0026 git push --tags\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdata-fair%2Fapp-charts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdata-fair%2Fapp-charts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdata-fair%2Fapp-charts/lists"}