Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gbmhunter/ninjacalc
An embedded engineering calculator toolbox for doing calculations in a breeze.
https://github.com/gbmhunter/ninjacalc
calculations calculator embedded engineering nextjs react web webstorm
Last synced: 1 day ago
JSON representation
An embedded engineering calculator toolbox for doing calculations in a breeze.
- Host: GitHub
- URL: https://github.com/gbmhunter/ninjacalc
- Owner: gbmhunter
- Created: 2015-10-24T01:57:36.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-31T07:26:36.000Z (8 months ago)
- Last Synced: 2024-04-23T05:07:27.657Z (7 months ago)
- Topics: calculations, calculator, embedded, engineering, nextjs, react, web, webstorm
- Language: JavaScript
- Homepage: http://gbmhunter.github.io/NinjaCalc/
- Size: 24.7 MB
- Stars: 23
- Watchers: 3
- Forks: 3
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# NinjaCalc
## Dev Usage
To install dependencies and start development server (`yarn` is recommended):
```bash
yarn install
yarn dev
```
By default, the local server will start at `localhost:3000`.
To run all unit/functional tests:
```bash
yarn test
```
To run unit/functional tests which match a particular pattern:
```bash
yarn test
```
e.g. to run all tests in `utils/standard-resistance-finder.test.js`:
```bash
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.