Development

Development Setup

Requirements

• Node.js 18+
• npm

Local Setup

git clone https://github.com/IlliniOpenEdu/PhysicsSims.git
cd PhysicsSims
npm install
npm run dev

Vite will print a local URL, typically http://localhost:5173.

Scripts

npm run dev      # start development server
npm run build    # type-check + production build
npm run preview  # preview production build
npm run lint     # run eslint
npm run deploy   # build and publish dist/ to GitHub Pages

Notes

• This repository is configured for GitHub Pages project-site hosting.
• vite.config.ts uses base: '/PhysicsSims/'.
• Build output includes dist/404.html copied from dist/index.html so client-side routes work on refresh.

Contributor Architecture Notes

Primary app wiring points:

• Route registration and app-level constants: src/App.tsx
• Internal admin state and persistence keys: src/config/internalAdmin.ts
• Collider defaults, bounds, detector map: src/lib/collider/constants.ts
• Collider runtime update cadence: src/hooks/useColliderSimulation.ts

When changing behavior, locate the source constant first and update docs in Hardcoded Values and Keys.

Local Contributor Checklist

1. Run npm run lint.
2. Run npm run build.
3. Test at least one sim in each track (mechanics, E&M, statics).
4. If you changed routes or admin visibility, verify nav links and featured content still work.
5. If you changed any hardcoded key/path/ID, update Hardcoded Values and Keys.