search

gbmhunter / NinjaCalc

An embedded engineering calculator toolbox for doing calculations in a breeze.
http://gbmhunter.github.io/NinjaCalc/
27 stars 3 forks source link
calculations calculator embedded engineering nextjs react web webstorm

readme

NinjaCalc

Build Status

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.