{"id":13554962,"url":"https://github.com/microsoft/charticulator","last_synced_at":"2025-04-03T07:33:30.567Z","repository":{"id":37953016,"uuid":"109045913","full_name":"microsoft/charticulator","owner":"microsoft","description":"Interactive Layout-Aware Construction of Bespoke Charts","archived":true,"fork":false,"pushed_at":"2024-01-09T17:35:15.000Z","size":11461,"stargazers_count":832,"open_issues_count":245,"forks_count":116,"subscribers_count":49,"default_branch":"master","last_synced_at":"2024-08-01T12:33:31.604Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/microsoft.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":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-10-31T19:56:39.000Z","updated_at":"2024-07-22T05:43:28.000Z","dependencies_parsed_at":"2023-02-15T08:02:03.715Z","dependency_job_id":"4962bc67-35c6-4ab0-843d-77c5b5a99d39","html_url":"https://github.com/microsoft/charticulator","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/microsoft%2Fcharticulator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fcharticulator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fcharticulator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/microsoft%2Fcharticulator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/microsoft","download_url":"https://codeload.github.com/microsoft/charticulator/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222935629,"owners_count":17060398,"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":[],"created_at":"2024-08-01T12:02:58.696Z","updated_at":"2024-11-04T03:31:34.160Z","avatar_url":"https://github.com/microsoft.png","language":"TypeScript","readme":"\n[![Build Status](https://travis-ci.org/Microsoft/charticulator.svg?branch=master)](https://travis-ci.org/Microsoft/charticulator)\n\nCharticulator\n====\n\nCharticulator is a new charting tool that allows you to design charts by interactively specifying\nconstraints.\n\nProject Team\n----\n\n- [Donghao Ren](https://donghaoren.org/)\n- [Bongshin Lee](http://research.microsoft.com/en-us/um/people/bongshin/)\n- [Matthew Brehmer](https://www.microsoft.com/en-us/research/people/mabrehme/)\n- [Nathan Evans](https://github.com/natoverse)\n- [Kate Lytvynets](https://github.com/katua)\n- [David Tittsworth](https://github.com/stopyoukid)\n- [Chris Trevino](https://github.com/darthtrevino)\n\nBuild\n----\n\nFollow the following steps to prepare a development environment:\n\n- Install nodejs 8.0+: \u003chttps://nodejs.org/\u003e\n- Install yarnjs 1.7+: \u003chttps://yarnpkg.com/\u003e\n\nInstall node modules:\n\n```bash\nyarn\n```\n\nCopy the template configuration file and edit its contents:\n\n```bash\ncp config.template.yml config.yml\n# (on windows, use copy instead of cp)\n```\n\nRun the following command to build Charticulator, which will create a self contained bundle in the `dist` folder:\n\n```bash\nyarn build\n```\n\nRun a local web server to test Charticulator:\n\n```bash\n# Serve Charticulator at http://localhost:4000\nyarn server\n\n# Serve Charticulator publicly at http://0.0.0.0:4000\n# Use this if you want to enable access from another computer\nyarn public_server\n```\n\nDevelopment\n----\n\nFor a live development environment, keep the following command running:\n\n```bash\nyarn start\n```\n\nThis command watches for any change in `src/` and `sass/`, and recompiles Charticulator automatically.\nOnce this up, open \u003chttp://localhost:4000/\u003e\nto launch Charticulator. Now when you change the source code, the app can be updated by simply\nrefreshing the browser page (you may need to disable browser cache).\n\nIn development mode, there is a test application for UI components, which can be accessed at \u003chttp://localhost:4000/test.html\u003e.\n\nThe watch mode won't update when you change the following:\n\n- config.yml\n- THIRD_PARTY.yml\n- webpack.config.js\n\nWhen you update these, please do `yarn build` again.\n\n### Sample Datasets\nYou can add custom sample datasets that can be used with Charticulator.  To do so, create a `datasets` folder at the root of the repository(if it doesn't exist), add your `.csv` (or `.tsv`) to that folder, and finally create a `files.json` file in the folder with the following contents:\n\n```\n[\n    {\n        \"name\": \"\u003cYour dataset display name\u003e\",\n        \"description\": \"\u003cYour dataset desription\u003e\",\n        \"tables\": [\n            {\n                \"name\": \"\u003cYour dataset file name without extension\u003e\",\n                \"type\": \"\u003ccsv || tsv\u003e\",\n                \"url\": \"\u003cYour dataset file name with extension\u003e\"\n            }\n        ]\n    }\n]\n```\n\nTesting\n----\n\nCharticulator currently include a rudimentary test code:\n\n```bash\nyarn test\n```\n\nMore test cases are needed.\n\n\n# Contributing\n\nThis project welcomes contributions and suggestions.  Most contributions require you to agree to a\nContributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us\nthe rights to use your contribution. For details, visit https://cla.microsoft.com.\n\nWhen you submit a pull request, a CLA-bot will automatically determine whether you need to provide\na CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions\nprovided by the bot. You will only need to do this once across all repos using our CLA.\n\nThis project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).\nFor more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or\ncontact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.\n\n# Documentation\n\nRun `yarn typedoc` to generate documentation pages.\nThe page will be awailable in [`./docs/charticulator`](./docs/charticulator/index.html)\n\nStart point of documentation is index page {@link \"index\"}","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fcharticulator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmicrosoft%2Fcharticulator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmicrosoft%2Fcharticulator/lists"}