Skip to content
alkemist / an open workbench

Getting started

Run the Alkemist development site and understand the current foundation.

Alkemist is being built as an updatable Astro toolkit for inventors and researchers. This website is its first consumer: the demo, documentation, and development notebook all use the shared Alkemist theme.

Run the repository

The current source repository requires access to alkemdev/alkemist. It is not yet a published starter package.

git clone [email protected]:alkemdev/alkemist.git
cd alkemist
npm ci
npm run dev

Use Node 24.20.0 from .nvmrc, or a supported Node version of at least 22.12.0. The current Astro checker supports TypeScript 6; the workspace pins compatible versions.

npm run verify

This runs Astro’s type checks, deployment-contract tests, the production build, and the built-site audit. It does not deploy.

Where things live

  • apps/site/src/content/docs: the handbook you are reading.
  • apps/site/src/content/notebook: development articles.
  • apps/site/src/pages: site-owned routes.
  • packages/ui: AlkLayout and theme tokens.
  • packages/astro: the Astro integration and shared Markdown/MDX configuration.

What comes next

The next feature milestone is an article containing math, a diagram, a real CSV chart, and a real GLB model viewer. The component roadmap distinguishes available features from proposed ones.