Getting Started

Use this guide to bring up the MolTrace workspace without changing runtime behavior.

Prerequisites

• Node.js and npm for the docs app
• Node.js and pnpm for the frontend app
• Python and uv for the backend app
• Access to the MolTrace workspace checkout

Start the apps

From the repository root, start the services you need:

cd moltrace_backend
PYTHONPATH=src uv run uvicorn nmrcheck.web:app --reload --host 0.0.0.0 --port 8000

cd moltrace_frontend
pnpm dev --hostname 0.0.0.0 --port 3000

cd moltrace_docs
npm run dev

Verify

• Backend health: http://localhost:8000/system/health
• Frontend app: http://localhost:3000
• Docs site: the URL printed by Astro, usually http://localhost:4321

Add guide pages

Starlight uses file-based routing. Add authored documentation inside src/content/docs/guides/ so guide pages are served under /guides/.

• src/content/docs/guides/index.mdx becomes /guides/
• src/content/docs/guides/quickstart.md becomes /guides/quickstart/
• src/content/docs/guides/core-concepts.md becomes /guides/core-concepts/
• src/content/docs/guides/modules/spectracheck/index.md becomes /guides/modules/spectracheck/

Every Markdown or MDX page must include valid frontmatter with at least a title.