{"id":13581563,"url":"https://github.com/multi-coop/datami","last_synced_at":"2025-04-06T10:32:43.555Z","repository":{"id":182008248,"uuid":"610341303","full_name":"multi-coop/datami","owner":"multi-coop","description":"Datami's mirror repo (source on Gitlab)","archived":false,"fork":false,"pushed_at":"2025-03-06T15:57:43.000Z","size":27724,"stargazers_count":31,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-06T16:22:08.662Z","etag":null,"topics":["apexcharts","dataviz","git","maplibre","vuejs","webcomponents","widget"],"latest_commit_sha":null,"homepage":"https://datami.multi.coop","language":"Vue","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/multi-coop.png","metadata":{"files":{"readme":"README.md","changelog":"changelog/entries.md","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,"publiccode":null,"codemeta":null}},"created_at":"2023-03-06T15:23:37.000Z","updated_at":"2025-02-20T21:39:19.000Z","dependencies_parsed_at":"2023-07-18T12:15:13.568Z","dependency_job_id":"8243df4e-e146-4844-b231-1a92a432cc8d","html_url":"https://github.com/multi-coop/datami","commit_stats":{"total_commits":565,"total_committers":5,"mean_commits":113.0,"dds":"0.11858407079646016","last_synced_commit":"79ff9a8ecb43a3461a1ead9ce42f9b4625d0605a"},"previous_names":["multi-coop/datami"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multi-coop%2Fdatami","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multi-coop%2Fdatami/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multi-coop%2Fdatami/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/multi-coop%2Fdatami/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/multi-coop","download_url":"https://codeload.github.com/multi-coop/datami/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247470371,"owners_count":20944146,"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":["apexcharts","dataviz","git","maplibre","vuejs","webcomponents","widget"],"created_at":"2024-08-01T15:02:05.730Z","updated_at":"2025-04-06T10:32:38.534Z","avatar_url":"https://github.com/multi-coop.png","language":"Vue","funding_links":[],"categories":["Vue","git"],"sub_categories":[],"readme":"![LOGO-DATAMI](./src/assets/logo_DATAMI_title.png)\n\n\u003c!-- \u003cimg src=\"./src/assets/logo_DATAMI_title.png\" alt=\"drawing\" width=\"120\" style=\"float: left; margin-right:10px\"/\u003e --\u003e\n\n---\n\u003c!-- #  DATAMI --\u003e\n**Contribute easily to data stored with git**\n_but without having to use Github or Gitlab interfaces_\n\n---\n\n## Summary\n\n- [What is Datami for ?](#what-is-datami-for-)\n- [Websites](#websites-)\n- [Documentation](#documentation-)\n- [Project setup](#project-setup-)\n- [Testing examples](#testing-examples-)\n- [Stack](#stack-)\n\n---\n\n## What is Datami for ? [⇡](#summary)\n\nThis project aims to create a serie of widgets to interact with ressources stored on Gitlab, Github, or mediawiki :\n\n- **Edit data stored on github or gitlab** (`csv`, `md`, or `json` files) ;\n- **Allow unidentified users to push on a separate branch** and automatically create a pull request ;\n- **Create a set of components for modular uses** :\n  - preview for `.csv`, `.md`, `.json` files or `mediawiki` ressources, with several choices for preview (table, cards list, ...) ;\n  - files edition interfaces ;\n  - dataviz for `.csv` files (barcharts, pies, ...) ;\n  - user preferences: language, user token, ...\n  - etc...\n- **Web integration as modular web component**\n\n---\n\n## Websites [⇡](#summary)\n\n- Official website : [datami.multi.coop](https://datami.multi.coop/)\n\n### Prod deploy \u0026nbsp; [![Netlify Status](https://api.netlify.com/api/v1/badges/1cd66edf-3b08-43db-bd21-6490377bb24a/deploy-status)](https://app.netlify.com/sites/datami-widget/deploys)\n\n- Website (widgets demo) : [datami-widget.multi.coop](https://datami-widget.multi.coop/)\n\n### Preprod deploy\n\n- Preprod : [Datami (preprod on Netlify)](https://preprod--datami-widget.netlify.app/)\n\n---\n\n## Documentation [⇡](#summary)\n\nCheck out our brand new documentation website for technical support :\n\n- Documentation website : [datami-docs.multi.coop](https://datami-docs.multi.coop)\n\n---\n\n## Project setup [⇡](#summary)\n\nThe current project is working with `npm 8.3.2` version\n\nTo install it, use the command :\n\n```bash\nnpm install -g npm@8.3.2\n```\n\nThen you can install the dependancies and add a dummy `.env` file based on the example.\n\n```bash\nnvm use\nnpm install\n\n# and copy the example .env file\ncp example.env .env\n```\n\n### Compiles and hot-reloads for development\n\nTo run locally Datami you just have to type :\n\n```bash\nnpm run serve\n```\n\n### Compiles and minifies for production\n\n```bash\nnpm run build\n```\n\n### Run your unit tests\n\n```bash\nnpm run test:unit\n```\n\n### Lints and fixes files\n\n```bash\nnpm run lint\n```\n\n### Customize configuration\n\nSee [Configuration Reference](https://cli.vuejs.org/config/).\n\n---\n\n## Testing examples [⇡](#summary)\n\nSome http files are stored in the [`./http-tests`](./http-tests) folder, showing examples of Datami working as a stand-alone widget embedded in a page in a shadow DOM.\n\nSetup :\n\n```bash\nnvm use \n\n# Option one - Build the app\nnpm run build\n\n# Option 2 - Run the app to serve the script\nnpm run serve\n```\n\n_Note : Depending on the option you will chose, you will have to check where to point to the Datami script in the html file. Some files are commented to check the different approaches._\n\nThen you can launch the http server :\n\n```bash\nnvm use\n\n# Run the server\nnpm run http\n```\n\nThe server will automatically open a page in your brower at `http://localhost:8180/html-tests/`\n\n---\n\n# Stack [⇡](#summary)\n\nWe only used open source packages and technologies, coz' that's what we do... :\n\n- [`Vue.js` (2.x)](https://v2.vuejs.org/v2/guide) : yes we like this framework a lot...\n- [`VueX`](https://vuex.vuejs.org/): the data store shared for every web component ;\n- [`vue-custom-element`](https://github.com/karol-f/vue-custom-element): wrapper for vue web components ;\n- [`gray-matter`](https://www.npmjs.com/package/gray-matter): package to convert `md` or `yaml` content to object ;\n- [`Showdown`](https://www.npmjs.com/package/showdown) and [`showdown-table` extension](https://github.com/showdownjs/table-extension#readme): package to convert `md` content to `html` (see [docs for showdown extensions](https://github.com/showdownjs/showdown#extensions));\n- [`Bulma`](https://bulma.io/) and [`Buefy`](https://buefy.org/) : as UI frameworks for vue ;\n- [`Material Design`](https://materialdesignicons.com/) fonts: for icons ;\n- [`Fetch`](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API/Using_Fetch): for requests to Github's or Gitlab's API ;\n- [`JSDiff`](https://github.com/kpdecker/jsdiff) : to get diff between an original content and its edited version\n- [`Diff2html`](https://www.npmjs.com/package/diff2html) : to display diff like in github / gitlab\n- [`MapLibre`](https://maplibre.org) : the open and free fork from MapboxGl.js to make maps\n- [`ApexCharts`](https://apexcharts.com) : an open library to make charts\n- ...and a lot of Stackoverflow help...\n\n---\n\nDatami is an open source project by the tech cooperative **[multi](https://multi.coop)**\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmulti-coop%2Fdatami","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmulti-coop%2Fdatami","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmulti-coop%2Fdatami/lists"}