Skip to content
/ recalc Public

A collaboration focused mechanical design calculator, primarily for FRC

License

Notifications You must be signed in to change notification settings

tervay/recalc

Repository files navigation

ReCalc is a collaboration focused mechanical design calculator, primarily for FRC.

Local setup

You'll need Node version 18 and Yarn version 1.22.

$ yarn

If you want to run UI tests, you'll need to install a few dependencies beforehand in order to run Cypress. Read Cypress official docs for instructions regarding your OS.

https://docs.cypress.io/guides/getting-started/installing-cypress

Basic dev commands:

yarn start - start server

yarn build - build to ./build

yarn test - run tests

yarn dev:cypress-run - run UI e2e tests

yarn dev:cypress-run --component - run UI component tests

yarn dev:analyze - check bundle sizes

yarn dev:coverage - run test coverage report

yarn dev:format - format source files

yarn dev:encrypt - encrypt secrets/credentials

yarn dev:webp - convert images to .webp


Priority list

  1. UI tests
  2. Docs
  3. Target reduction -> Gearbox calc
  4. ILITE Drivetrain calc
  5. CSS overhaul
  6. Export models to csv/json
  7. PDF renderer