{"id":15063114,"url":"https://github.com/inab/oeb-visualizations","last_synced_at":"2025-04-10T10:34:00.700Z","repository":{"id":208276881,"uuid":"721103020","full_name":"inab/oeb-visualizations","owner":"inab","description":"Library of data visualizations for OpenEBench","archived":false,"fork":false,"pushed_at":"2025-04-02T14:55:58.000Z","size":15878,"stargazers_count":0,"open_issues_count":4,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-02T15:38:13.471Z","etag":null,"topics":["openebench","plotlyjs","vue"],"latest_commit_sha":null,"homepage":"https://inab.github.io/oeb-visualizations/","language":"HTML","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/inab.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-11-20T11:10:39.000Z","updated_at":"2024-10-24T14:08:56.000Z","dependencies_parsed_at":"2024-05-09T13:57:00.955Z","dependency_job_id":"2faee0d6-c9b7-4634-a981-4451d9982656","html_url":"https://github.com/inab/oeb-visualizations","commit_stats":{"total_commits":64,"total_committers":3,"mean_commits":"21.333333333333332","dds":0.1875,"last_synced_commit":"645e17a5a981814ccd5f19df159509fe3defd09d"},"previous_names":["evamart/oeb-visualizations","inab/oeb-visualizations"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inab%2Foeb-visualizations","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inab%2Foeb-visualizations/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inab%2Foeb-visualizations/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/inab%2Foeb-visualizations/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/inab","download_url":"https://codeload.github.com/inab/oeb-visualizations/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248199245,"owners_count":21063641,"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":["openebench","plotlyjs","vue"],"created_at":"2024-09-24T23:51:39.497Z","updated_at":"2025-04-10T10:34:00.670Z","avatar_url":"https://github.com/inab.png","language":"HTML","readme":"# OpenEBench Visualizations\n\nCollection of Vue components for data visualization in [OpenEBench](https://openebench.bsc.es/). \n\n- :magic_wand: Go to the [live demo](https://inab.github.io/oeb-visualizations-demo/) to see the components in action.\n- :open_book: Check the [documentation](https://inab.github.io/oeb-visualizations/) for details on how to use the components.\n- :package: This package is available through [npmjs](https://www.npmjs.com/package/@inb/oeb_visualizations). \n\n\n## Installation\n\nTo install the package run: \n\n```bash\nnpm install @inb/oeb_visualizations\n``` \n## How to contribute \n\nIf you want to contribute to this project, please read the [contributing guidelines](/CONTRIBUTING.md) first.\n\n## Development \n\nThis project is built using [Vue.js](https://vuejs.org/). The components are written in [Vue](https://vuejs.org/) and the bundling is done using [Rollup](https://rollupjs.org/). The rollup configuration is in the `rollup.config.js` file and the main entry point is the `src/index.js` file, all the components are exported from this file. \nThe components are written in the `src/components` folder. Each component should be in a separate folder and should contain the `.vue` file and, optionally, a `.scss` file. In order to be used in other applications, the package should be built, which creates a `dist` folder with the compiled files.\n\nThe documentation is built using [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/). The content of the documentation is written in markdown and should be added to the `docs` folder. \nThe configuration of the documentation is in the `mkdocs.yml` file. This file contains the structure of the documentation, including navigation, the theme used, etc. More information about how to configure the documentation can be found in the [documentation](https://squidfunk.github.io/mkdocs-material/reference/).\n\n### How to add a new visualization.\n\nIf you want to add a new visualization, you should create a new component for it. Follow the steps below:\n\n- Create the new component in the `src/components` folder. A component can be written in only one file or, if it is complex, it can be divided into smaller components in a folder.  \n- Add the new component to the `index.js`, as following: \n\n    ```js\n    import newComponent from './components/newComponent.vue'\n\n    export {\n        newComponent,\n        ...\n    }\n    ```\n\n\u003e If the new component is a complex component, it should be divided into smaller components. In this case, the `index.js` file should export the smaller components and the main component. \n\n\u003e The documentation should be updated to include the new component.\n\n### How to document a new component.\n\nTo document a new component, add the new component to the documentation as a single file in the `docs/components` folder. Documentation is written in markdown and should contain at least the following sections: \n\n- Description of how the data being represented. \n- How to use it. \n- Example of usage. \n- Props and events. \n\n### How to build the package locally. \n\nTo build the package locally, run: \n```bash\nnpm run build\n```\nThis will create a `dist` folder with the compiled files.\nThe component will be available for other applications running locally to use. \nTo use the component in another application, you should link the package locally. To do so, run: \n```bash\nnpm link\n```\nThen, in the application where you want to use the component, run: \n```bash\nnpm link @inb/oeb_visualizations\n```\nThis will link the local package to the application.\n\n### How to serve the documentation locally.\n\nThe documentation is built using [mkdocs](https://www.mkdocs.org/). To serve the documentation locally, run:\n```bash\nmkdocs serve\n```\nThis will start a local server and the documentation will be available at `http://localhost:8000/`.\n\n\n## Publishing \n\n### Publishing a new version of the package to npm\n\nTo publish a new version of the package to [npm](https://www.npmjs.com), follow the steps below:\n\n- Update the version in the `package.json` file. If all commit messages follow the [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) standard, you can use the `cz bump --version-scheme semver` command to update the version and the `CHANGELOG.md` file. \n- Run the `npm run build` command to build the package. \n- Run the `npm publish` command to publish the package to npmjs.\n\nThis package is published under the `@inb` scope as `@inb/oeb_visualizations`. \nThe package is available at [https://www.npmjs.com/package/@inb/oeb_visualizations](https://www.npmjs.com/package/@inb/oeb_visualizations).\n\n### Publishing the documentation\n\nThe documentation is built and deployed to the `gh-pages` branch using GitHub Actions. Each time a new commit is pushed to the `main` branch, the documentation is built and deployed to the `gh-pages` branch.  \nThe documentation is available at [https://inab.github.io/oeb-visualizations/](https://inab.github.io/oeb-visualizations/).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finab%2Foeb-visualizations","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Finab%2Foeb-visualizations","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Finab%2Foeb-visualizations/lists"}