How manavtriv/qsm-ci-platform works
Project type and purpose
• This is a single-page React application (built with Vite) that serves as a front-end “platform” for visualizing, comparing, and ranking Quantitative Susceptibility Mapping (QSM) algorithms.
• It relies on a Backend-as-a-Service (Parse/Back4App) for data persistence and ELO ranking logic.
File structure
• Top-level:
• .github/workflows – CI jobs (tests, Vercel deploy)
• public + index.html – static assets & host page
• src/ – all front-end code:
◦ components/ – UI building blocks (Algorithm pages, Niivue viewer, charts, tables, filters)
◦ pages/ – route entry points (Home, Overview, Compare, etc.)
◦ hooks/ – custom React hooks encapsulating data-fetching and business logic
◦ api/ – Parse JS SDK initialization & API wrappers
◦ config/ – metrics & tag-group definitions
◦ routes/ – React Router setup
◦ utils/ – helper functions
◦ styles/ – global CSS (Tailwind)
• test/ + __tests__ – Vitest + React Testing Library setup and tests
• Vite, ESLint, Vitest, and environment (.env.example) files configure build, lint, test, and runtime.
Insights from README
• SPA with React Router v7
• Styling via Tailwind CSS
• Interactive 3D imaging via Niivue
• Charts via Recharts
• Data persistence and ranking logic via Parse/Back4App JS SDK
• Deployment to Vercel, CI via GitHub Actions
Detail
• Break the front end into Pages, Components, and Hooks.
• config modules feeding into Hooks or Components.
• public/index.html + Vite build as the entry point.
• Don’t omit the .env → API keys → Parse SDK relationship.
• CI workflows for testing & deployment.