Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
70 changes: 69 additions & 1 deletion site/page.ts
Original file line number Diff line number Diff line change
Expand Up @@ -30,10 +30,78 @@ const basicSections = [
section(
'start',
'Installation',
h('h3', { id: 'create-project' }, 'Create a project'),
h(
'p',
null,
'Add Radi to your project. The reference describes the current repository API; check exports and types against your installed version before using newer features.',
'Open a terminal with Node.js 22+ and npm installed. Allow about 5 minutes for the SPA setup, depending on download speed.',
),
h('h3', null, 'Step 1: Create your app'),
code('Terminal', 'npm create radi@latest -- my-app --template spa', 'bash'),
h(
'p',
null,
'Use a new or empty directory. The generator refuses nonempty destinations and does not install dependencies.',
),
h('h3', null, 'Step 2: Install dependencies'),
code('Terminal', 'cd my-app\nnpm install', 'bash'),
h('h3', null, 'Step 3: Start the development server'),
code('Terminal', 'npm run dev', 'bash'),
h('h3', null, 'Step 4: Open your app'),
h(
'p',
null,
'Open http://127.0.0.1:3000. Your Radi app is running. Edit app.tsx, save, and reload the browser to see your change.',
),
h('h3', { id: 'choose-template' }, 'Choose another template'),
h(
'p',
null,
'Replace spa in the create command with the template you need:',
),
h(
'ul',
null,
h(
'li',
null,
h('code', null, 'spa'),
' — a browser-rendered app. Start here if you are unsure.',
),
h(
'li',
null,
h('code', null, 'ssr'),
' — HTML rendered by a Node server for each request.',
),
h(
'li',
null,
h('code', null, 'ssg'),
' — HTML generated at build time for a static host.',
),
h(
'li',
null,
h('code', null, 'go'),
' — a Go server with embedded V8 for rendering.',
),
),
h(
'p',
null,
'The Go starter also requires Linux amd64 with glibc, Go 1.26.10, Clang 21, and CGO enabled. Follow its generated README.md to set the compiler environment before running npm run dev.',
),
h(
'p',
null,
'Each generated README.md explains editing, building, and deployment for that template.',
),
h('h3', { id: 'existing-project' }, 'Use an existing project'),
h(
'p',
null,
'Already created a starter? Skip this manual setup. To add Radi to an existing project, follow the steps below. The reference describes the current repository API; check exports and types against your installed version before using newer features.',
),
h('h3', { id: 'install-package' }, 'Add the package'),
code(
Expand Down
Loading