Refactor README and add a mortgage calculator demo

sequba commented 4 months ago

Context

New demo for the README. Using PMT function to implement a simple mortgage calculator.

Should be merged together with https://github.com/handsontable/hyperformula-demos/pull/24

How did you test your changes?

[x] verify that the codesandbox link works
[x] verify that the code snippet works when copied to codesandbox

Types of changes

[ ] Breaking change (a fix or a feature because of which an existing functionality doesn't work as expected anymore)
[ ] New feature or improvement (a non-breaking change that adds functionality)
[ ] Bug fix (a non-breaking change that fixes an issue)
[ ] Additional language file, or a change to an existing language file (translations)
[x] Change to the documentation

Related issues:

Fixes #1380

Checklist:

[x] I have reviewed the guidelines about Contributing to HyperFormula and I confirm that my code follows the code style of this project.
[ ] I have signed the Contributor License Agreement.
[x] My change is compliant with the OpenDocument standard.
[x] My change is compatible with Microsoft Excel.
[x] My change is compatible with Google Sheets.
[ ] I described my changes in the CHANGELOG.md file.
[ ] My changes require a documentation update.
[ ] My changes require a migration guide.

github-actions[bot] commented 4 months ago

Performance comparison of head (0f4e3502372cf022fd91d9d855130e9a0fff43d0) vs base (38a5988b3f7bf9eff0246ab036cd6574a52a7838)

                                     testName |   base |   head |  change
-------------------------------------------------------------------------
                                      Sheet A | 542.32 | 536.95 |  -0.99%
                                      Sheet B | 178.48 | 172.08 |  -3.59%
                                      Sheet T | 157.26 | 153.53 |  -2.37%
                                Column ranges | 556.45 | 560.47 |  +0.72%
Sheet A:  change value, add/remove row/column |  14.88 |  15.08 |  +1.34%
 Sheet B: change value, add/remove row/column | 146.76 | 130.28 | -11.23%
                   Column ranges - add column | 165.76 | 144.66 | -12.73%
                Column ranges - without batch | 486.55 | 438.01 |  -9.98%
                        Column ranges - batch | 124.09 | 116.24 |  -6.33%

sequba commented 3 months ago

@krzysztofspilka @evanSe The mortgage calculator demo in codesandbox should be fixed now.

codecov[bot] commented 3 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 97.37%. Comparing base (38a5988) to head (60deb6e).

:exclamation: Current head 60deb6e differs from pull request most recent head 0f4e350. Consider uploading reports for the commit 0f4e350 to get more accurate results

Additional details and impacted files

[![Impacted file tree graph](https://app.codecov.io/gh/handsontable/hyperformula/pull/1387/graphs/tree.svg?width=650&height=150&src=pr&token=5k9ZQv8azO&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=handsontable)](https://app.codecov.io/gh/handsontable/hyperformula/pull/1387?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=handsontable) ```diff @@ Coverage Diff @@ ## develop #1387 +/- ## ======================================== Coverage 97.37% 97.37% ======================================== Files 169 169 Lines 14428 14428 Branches 3099 3099 ======================================== Hits 14049 14049 Misses 376 376 Partials 3 3 ```

handsontable / hyperformula