{"id":18287072,"url":"https://github.com/handsontable/hyperformula-demos","last_synced_at":"2025-04-05T08:31:34.248Z","repository":{"id":37966023,"uuid":"272642770","full_name":"handsontable/hyperformula-demos","owner":"handsontable","description":null,"archived":false,"fork":false,"pushed_at":"2025-01-21T12:26:21.000Z","size":7015,"stargazers_count":14,"open_issues_count":0,"forks_count":9,"subscribers_count":11,"default_branch":"develop","last_synced_at":"2025-03-21T00:51:08.165Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","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/handsontable.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":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2020-06-16T07:44:03.000Z","updated_at":"2025-01-21T12:26:26.000Z","dependencies_parsed_at":"2024-01-03T15:53:45.180Z","dependency_job_id":"8c37aaa3-38b7-47b8-8293-36d38dfa3bad","html_url":"https://github.com/handsontable/hyperformula-demos","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/handsontable%2Fhyperformula-demos","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/handsontable%2Fhyperformula-demos/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/handsontable%2Fhyperformula-demos/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/handsontable%2Fhyperformula-demos/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/handsontable","download_url":"https://codeload.github.com/handsontable/hyperformula-demos/tar.gz/refs/heads/develop","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247311622,"owners_count":20918336,"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-11-05T13:24:15.879Z","updated_at":"2025-04-05T08:31:34.201Z","avatar_url":"https://github.com/handsontable.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hyperformula-demos\n\nThis repository contains demos and usage examples for the [HyperFormula](https://github.com/handsontable/hyperformula) library. Some of them are embedded in the [HyperFormula documentation](https://handsontable.github.io/hyperformula/).\n\n## Branches\n\nWe keep:\n- **develop** branch\n- version branches e.g. **1.0.x**, **1.1.x**, **2.0.x**\n\nThe demos on each version branch work with the corresponding version of HyperFormula.\n\n## Running the demos\n\nEach directory contains one demo. \n\n*Make sure to use the right version of the demos. E.g. for **hyperformula@1.3.1** you should use the code from branch **1.3.x**.*\n\n### In CodeSandbox.io\n\nThe demos are embedded in HyperFormula documentation using CodeSandbox.io so this should be treated as the primary execution environment for the demos.\n\nCodeSandbox.io uses `node@16.12.0` to run the demos as [configured](https://codesandbox.io/docs/configuration#sandbox-configuration) in `sandbox.config.json` file.\n\nThe CodeSandbox.io links in the documentation have this form:\n```js\n`https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/${branchName}/${directory}?autoresize=1\u0026fontsize=11\u0026hidenavigation=1\u0026theme=light\u0026view=preview`\n```\n\nE.g. a link for demo **basic-usage** from branch **2.0.x** looks like this:\nhttps://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.0.x/basic-usage?autoresize=1\u0026fontsize=11\u0026hidenavigation=1\u0026theme=light\u0026view=preview\n\n\n### Locally\n\nThe demos use different frameworks and technologies but all of them can be run using `npm run start` command.\n\n*We recommend using Node v16 to run the demos.*\n\n```bash\n# in hyperformula-demos directory\ncd basic-usage # or any other demo\nnpm install\nnpm run start\n```\n\nFor most demos the browser opens automatically with the correct URL. If it didn't, copy the URL from the console output and paste it into the browser.\n\nEvery demo prints the HyperFormula version to the console.\n\n## Development \u0026 maintenance\n\n### Branching policy\n\nOn the **develop** branch we:\n- create new demos\n- improve the existing demos\n- adjust the demos to the recent changes in HyperFormula's API\n\nFor each *major* and *minor* release of HyperFormula a new branch is created from **develop** with name indicating the released version.\n\nThe bugfixes for the previous versions are applied to the appropriate branches.\n\n### Updating HyperFormula version for all demos\n\nThis command updates the `package.json` file in all demos to use version *x.y.z* of hyperformula package:\n\n```bash\n# in hyperformula-demos directory\nsh set-hyperformula-version.sh x.y.z\n```\n\nThis command updates the `package-lock.json` file in all demos to use the latest version of hyperformula:\n\n```bash\n# in hyperformula-demos directory\nsh update-hyperformula-in-lock-files.sh\n```\n\n### Testing the demos with an unpublished version of HyperFormula\n\nTo achieve this a private package registry (such as [verdaccio](https://verdaccio.org/)) is necessary.\n\n*We recommend using Node v16 to test the demos.*\n\n1. Start verdaccio server\n```bash\nnpm i -g verdaccio # unless you have it already installed\nverdaccio\n# navigate to http://localhost:4873/ in your browser to make sure it's running\n```\n\n2. Publish current HyperFormula version to the local registry\n```bash\n# in hyperformula repository\n# make sure you have the right version number set in package.json\nnpm run bundle-all\nnpm adduser --registry http://localhost:4873\nnpm publish --registry http://localhost:4873\n```\n\n3. Install HyperFormula from the private registry\n```bash\n# in hyperformula-demos repository\ncd basic-usage # or any other demo\nnpm i --registry http://localhost:4873 hyperformula@1.2.3\nnpm run start\n# check the HyperFormula version number in the browser console\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhandsontable%2Fhyperformula-demos","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhandsontable%2Fhyperformula-demos","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhandsontable%2Fhyperformula-demos/lists"}