hyperformula-demos

This repository contains demos and usage examples for the HyperFormula library. Some of them are embedded in the HyperFormula documentation.

Branches

We keep:

• develop branch
• version branches e.g. 1.0.x, 1.1.x, 2.0.x

The demos on each version branch work with the corresponding version of HyperFormula.

Running the demos

Each directory contains one demo.

Make sure to use the right version of the demos. E.g. for [email protected] you should use the code from branch 1.3.x.

In CodeSandbox.io

The demos are embedded in HyperFormula documentation using CodeSandbox.io so this should be treated as the primary execution environment for the demos.

CodeSandbox.io uses [email protected] to run the demos as configured in sandbox.config.json file.

The CodeSandbox.io links in the documentation have this form:

`https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/${branchName}/${directory}?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview`

E.g. a link for demo basic-usage from branch 2.0.x looks like this: https://codesandbox.io/embed/github/handsontable/hyperformula-demos/tree/2.0.x/basic-usage?autoresize=1&fontsize=11&hidenavigation=1&theme=light&view=preview

Locally

The demos use different frameworks and technologies but all of them can be run using npm run start command.

We recommend using Node v16 to run the demos.

# in hyperformula-demos directory
cd basic-usage # or any other demo
npm install
npm run start

For 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.

Every demo prints the HyperFormula version to the console.

Development & maintenance

Branching policy

On the develop branch we:

• create new demos
• improve the existing demos
• adjust the demos to the recent changes in HyperFormula's API

For each major and minor release of HyperFormula a new branch is created from develop with name indicating the released version.

The bugfixes for the previous versions are applied to the appropriate branches.

Updating HyperFormula version for all demos

This command updates the package.json file in all demos to use version x.y.z of hyperformula package:

# in hyperformula-demos directory
sh set-hyperformula-version.sh x.y.z

This command updates the package-lock.json file in all demos to use the latest version of hyperformula:

# in hyperformula-demos directory
sh update-hyperformula-in-lock-files.sh

Testing the demos with an unpublished version of HyperFormula

To achieve this a private package registry (such as verdaccio) is necessary.

We recommend using Node v16 to test the demos.

1. Start verdaccio server

npm i -g verdaccio # unless you have it already installed
verdaccio
# navigate to http://localhost:4873/ in your browser to make sure it's running

2. Publish current HyperFormula version to the local registry

# in hyperformula repository
# make sure you have the right version number set in package.json
npm run bundle-all
npm adduser --registry http://localhost:4873
npm publish --registry http://localhost:4873

3. Install HyperFormula from the private registry

# in hyperformula-demos repository
cd basic-usage # or any other demo
npm i --registry http://localhost:4873 [email protected]
npm run start
# check the HyperFormula version number in the browser console