Skip to content

Deployment

Jump to bottom
Bryan Chen edited this page Apr 16, 2026 · 1 revision

Deployment

Target URL

One-Time GitHub Setup

  1. Ensure the repository exists at IlliniOpenEdu/PhysicsSims.
  2. In GitHub, open Settings -> Pages.
  3. Set Source to Deploy from a branch.
  4. Choose branch gh-pages and folder /(root).

Deploy Command

npm install
npm run deploy

Routing Notes

  • This project deploys as a GitHub Pages project site.
  • vite.config.ts uses base: '/PhysicsSims/'.
  • dist/404.html mirrors dist/index.html to support route refresh.

PhysicsSims Docs

Start Here

Contributor References

Quick Contributor Flow

  1. Read Development Setup
  2. Check Hardcoded Values and Keys
  3. Make changes and verify locally
  4. Update docs in Simulation Catalog or other affected pages
  5. Follow PR checklist in Contributing

Clone this wiki locally