Skip to content

OpenPhysics/TheRamp

The Ramp

A SceneryStack reimplementation of PhET's classic The Ramp simulation — forces on an inclined plane. Built with SceneryStack, Vite 8, TypeScript 6, and Biome 2.

The sim has two screens, mirroring the original Java modules:

  • Introduction — the simple ramp
  • More Features — the advanced ramp

Features

  • Two-screen SceneryStack scaffold with per-screen model/view separation
  • English, French, and Spanish localization via StringManager
  • Default and projector color profiles
  • Progressive Web App (installable, offline-capable)
  • Git hooks for Biome pre-commit checks
  • Shared GitHub Actions CI via OpenPhysics/.github

Quick Start

npm install
npm run icons    # generate PNG icons from public/icons/icon.svg
npm start        # dev server → http://localhost:5173

Scripts

Command Description
npm start / npm run dev Start Vite dev server
npm run build Type-check + production build → dist/
npm run preview Preview the production build locally
npm run check TypeScript type check
npm run lint Biome lint check
npm run format Auto-format all files
npm run fix Lint + auto-fix
npm run icons Regenerate PNG icons from public/icons/icon.svg
npm run clean Remove dist/

The sim starts at version: "0.0.0" in package.json. Bump only when cutting a release (for example npm version patch and a matching git tag). The kebab-case name (the-ramp) matches the SceneryStack sim identifier in src/init.ts.

Tech Stack

Tool Version Purpose
SceneryStack ^3.0.0 Simulation framework
Vite ^8 Build tool + dev server
TypeScript ^6 Type-safe JavaScript
Biome ^2.4 Linting + formatting
vite-plugin-pwa ^1 PWA + service worker

License

GNU Affero General Public License v3.0 — see OpenPhysics org license.

Contributing

See OpenPhysics contributing guidelines. Report bugs via GitHub Issues; use org issue templates.

About

A SceneryStack reimplementation of PhET's classic The Ramp simulation : forces on an inclined plane

Resources

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Contributors

Languages