gbmhunter / ninjacalc

An embedded engineering calculator toolbox for doing calculations in a breeze.

NinjaCalc

Dev Usage

To install dependencies and start development server (yarn is recommended):

yarn install
yarn dev

By default, the local server will start at localhost:3000.

To run all unit/functional tests:

yarn test

To run unit/functional tests which match a particular pattern:

yarn test <pattern>

e.g. to run all tests in utils/standard-resistance-finder.test.js:

yarn test standard-resistance-finder

Tests

Unit tests that don't need to mount react components are saved in .test.js files next to the source code. Tests which need to mount a react component (e.g. functional tests for each calculator) are in __tests__/.

CICD

Unit/functional tests are run by GitHub actions. These are configured by the file .github/workflows/node.js.yaml.

Releasing

Update the CHANGELOG.md with the changes since the last release. Make sure to update the version in package.json, this is pulled in by the client-side javascript and displayed in the app.

Deployment is done automatically when changes are pushed to the master branch. Make sure to git tag with the correct version number. Deployment is done by Vercel, info can be found at https://vercel.com/gbmhunter/ninja-calc.

ninjacalc's Issues

Convert CalcVars object from Dictionary to List.

Add mandatory "category" and "tag" fields to the Calculator class.

Remove input variable to validator function.

Fix bug where inputs with failing validators are still o.k. on initial calculator start-up.

Move the react grid components from the 'src/utility/' folder to the 'src/components/' folder.

Stop calculators re-rendering unless they have to (serious performance issues).

Only the first level of dependencies in the chain are re-calculated on variable change.

Make the imageSrc path variable within each calculator relative to the calculator.

Tabs should stick to top of screen when scrolling through calculator data.

Add resistor divider calculator.

Add the ability to save the entire app state.

Make calculators scale appropriately as window is resized.

Can't see app icon on Windows 10 task bar.

Get "calc what" radio buttons working again (using Immutable-JS).

Only re-calculate dependent variables (currently if any one variable changes in a calculator instance, all variables are re-calculated).

Add info to README about how all dependency calculator variables must be read at the start of a equation function.

Add expanding functionality to the calculator intros and hide them by default.

Improve the appearance of the Ohm's Law calculator diagram.

Remove dragging mouse icon when hovering over calculator grid items.

Change release app logo to NinjaCalc logo.

Rename app title to "NinjaCalc".

Add drop shadow to calculator grid elements.

Design logo for NinjaCalc.

Make the calculator selection grid scrollable.

Add the ability to specify the size of a calculator (e.g. small, medium, large).

Add validator to Vout on resistor divider calculator to make sure it is less than Vin.

Center the text in the calculator table for the variable name and symbol.

Allow multiple instances of the same calculator type to be open.

Create re-usable WPF dimension element.

Add low pass RC filter calculator.

Make calculator selection grid expand to window size (with some fixed margin size).

Add info about Visio calculator diagrams to README.

Add info to README on how to create a new calculator (i.e a new calculator object).

Make the search scan through tag and title data.

Improve image for Track Current (IPC-2152) calculator.

Sign the application so warnings don't occur on install.

Add the ability to save the state of a single calculator instance.

Add rounding to calculator outputs.

Add track current calculator based on IPC-2152 standard.

Current flow symbol looks like diode symbol.

Center the calculator tables in the middle of their tabs.

Validators not working on unit change.

Add correct validators to IPC2221A track current calculator.

Move electronic-related calculators into "electronics" parent-level folder (and namespace).

Add test to make sure unit change to causes dependent outputs to re-calculate.

Add info to README on how to generate installer.

Add info section to IPC-2152 track current calculator.

Clicking 'Open' on a calculator in the grid view should open it's tab.

Add automatic rounding functionality to numerical calculator output variables.

Match the grid item shadow with the grid item (bottom border is mis-aligned).