Build & Deploy

Build & Deploy

Everything between npm ci and a live site: building implemented.stream itself, and building and deploying your own SDK apps.

What this zone covers

• Building, testing and deploying this docs site.
• The SDK features you use while building: routing, data, auth, jobs, email and edge rules.
• Running the self-hosted deploy platform in your own Cloudflare account.

Build and ship this docs site

These five commands build and ship implemented.stream itself. Building your own site? Follow the 9-step track instead.

1. Install the dependencies. This step uses the lockfile for a clean install.

   npm ci

   Example output: npm reports the number of packages added and exits without errors.

2. Start the local dev server. This step lets you preview the site in a browser.

   npm run dev

   Example output: VitePress prints a local URL to open.

3. Build the site. This step checks that every page compiles and every link resolves.

   npm run build

   Example output: the build completes with no dead-link errors.

4. Test in 2–3 rounds: build, link scan, then a desktop and mobile check. See Build this site.

5. Deploy only with the owner's approval. See Deploy your app and Production.

Safe deploys

Do not deploy from an untested branch. Production deploys need the owner's approval. Keep secrets out of code, templates and zips.

Find your topic

Group	Covers
This site	Build this site, Production
Routing & Rendering	Server routes, Pages, SSR, SSG
Data	Database, KV, Object storage, Durable state
Backend features	Auth, Jobs, Queues, Email, AI
Deploy & teams	Deployment, Remote development, Collaboration
Self-hosted platform	Overview, Administration, Development

Every page in this zone

Show all 68 pages, in sidebar reading order

Page	What it is for
Self-hosted platform	An SDK platform lets your team deploy apps into a shared Cloudflare account.
Prerequisites	What you need before installing the platform: Cloudflare features, accounts and local tools.
Credentials	Keep one password-manager entry for this platform. Paste the saved values into the installer when asked; most do not need shell environment variables.
Install and configure login	Press Enter to accept a suggested zone or display name, or type to replace it.
First deployment	Open your platform's API URL in a browser to see its welcome page, CLI connection instructions, and a link to the administrator dashboard.
Domains and resources	Connect your domain to the platform: zone, DNS and routing are set up in one command.
Maintenance and recovery	Run void platform list to find the installation slug beside its name.
Install from CI	For your first installation, follow the interactive setup. Use this page when automating a configured installation.
Disable and uninstall	Pause a platform without losing data, or remove it completely when you no longer need it.
Platform administration	void platform lets you manage the people and apps on an SDK platform from your terminal.
Sign-in and access	For the browser admin UI, open <API URL>/admin and use the administrator login method selected during setup.
Connected apps	A connected app is a separate application registered as an OAuth client on your SDK installation.
Users and projects	Find users and projects on your platform, inspect them, and change ownership, plans or status.
Plans and limits	Plans define the resource limits you assign to accounts on your platform.
Project Zero Trust	Project Zero Trust puts Cloudflare Access in front of the hostnames of projects deployed to your platform, including custom domains.
Email	These commands apply to a platform that enables email.
Operations	Commands that change the platform show the affected objects before asking for confirmation.
Developing an SDK platform	The framework, CLI, and platform live in one repository. You can change the platform, test it locally, and deploy a runtime built from your fork into your own Cloudflare account.
Local development	Run the platform from a local checkout: clone, install with Vite+, and start the dev stack.
Runtime and source builds	Build and publish the platform runtime from source, with the commit recorded in its manifest.
Schema and CI	The schema lives in platform/packages/api/src/schema.ts.
Build this site	Install, build, test and deploy implemented.stream from the agensdklab/devstacks repo.
Deployment	void deploy builds your app, provisions resources, applies migrations, and deploys it. Choose your own Cloudflare account or an SDK platform run by your team.
Production	Live URLs, the Cloudflare Worker behind implemented.stream, and what to check after a deploy.
Remote development	The SDK normally uses local D1, KV, and R2 through Miniflare.
Project Collaboration	A project hosted on an SDK platform can have one owner and additional readers, collaborators, and project administrators.
Server routing	Create a file in routes/ to add an endpoint, and export a handler for each HTTP method you want to support. The SDK uses Hono for routing and middleware.
Pages routing	Put UI components in pages/ to make them routes.
Layouts and shared data	Use layouts for navigation, headers, and other UI shared by several pages. Layouts nest with your directories and keep their component state as you navigate.
Loaders and props	A loader fetches the data a page needs. Define it in a companion .server.ts file using the same defineHandler API as server routes.
Actions and forms	Use an action to change server data from a form or button.
View transitions	Add animated page transitions with the browser’s View Transition API. Pages cross-fade by default; use CSS to customize the animation.
Head management	Set page titles and metadata with head(), middleware, or site-wide defaults. Page values take precedence over middleware and config.
Islands	Islands let you add interactive components to an otherwise static page.
Markdown	Add .md files to pages/ for Markdown routes. Pages inherit layouts and render as HTML, with JavaScript only for islands, client scripts, and code-copy buttons.
Static asset caching	The SDK caches static assets on Cloudflare's edge network. Hashed build files can be reused across deploys, while other files use cache keys tied to the deployment.
Revalidation (ISR)	Revalidation caches rendered pages and refreshes them in the background. When a cached page becomes stale, visitors can keep reading it while the Worker renders an updated version.
Edge prerendering	Prerender pages at deploy time so the first visitor receives cached HTML.
Custom headers	Define custom response headers in void.config.ts using the routing.headers field. Keys are URL patterns, values are arrays of 'Name: value' strings.
Redirects	Define URL redirects in void.config.ts using the routing.redirects field. Keys are source URL patterns, values are destination strings or objects with an explicit status.
Rewrites	A rewrite serves a route at a different URL without changing the browser's address.
Custom SSR	Use custom SSR to choose your own router, data loading, HTML shell, and hydration code. If you want the SDK to handle these for you, use Pages Routing.
Static site generation (SSG)	Prerender every page to static HTML at build time with output: 'static', and deploy the result anywhere.
Type Safety	The SDK infers types from your database schema, route handlers, and page loaders. When you change a field, TypeScript shows which queries, requests, and components need to change.
Database	Define your tables in TypeScript, then query them with db from void/db.
D1 (SQLite)	Cloudflare D1 is the SDK's default SQLite database. Start with a schema; the SDK manages the database locally and when you deploy.
PostgreSQL	Connect your PostgreSQL database through Cloudflare Hyperdrive, then use the same Drizzle schema and query workflow as D1.
MySQL	Connect your MySQL database through Cloudflare Hyperdrive, then define tables and query them with Drizzle.
Typed Fetch	Import fetch from void/client for route autocomplete, checked request bodies, and inferred response types.
Key-value storage	Read and write data in Cloudflare Workers KV with kv from void/kv. Values are stored as JSON, and kv.map() gives a collection its own key prefix and value type.
Object storage	Store files in Cloudflare R2 with storage from void/storage. It gives you the typed R2 API for uploads, downloads, and metadata.
Durable state	Use a Durable Object when requests need to share state under one name, such as a shopping cart, room, or rate limiter.
Environment variables	Declare your environment variables in env.ts, then read them through env from void/env. Use .env for local values and void secret put for production server values.
Authentication	The SDK configures Better Auth for your app, including its database connection, API routes, and client. Start with email and password, or add a social login provider.
AI	Run Workers AI models and provider APIs from server code with ai from void/ai. Provider requests use Cloudflare's AI Gateway.
Email	Use the SDK to send transactional email, receive messages in route handlers, and test outgoing mail in a local inbox.
Sending Email	Use sendEmail to send transactional email. During development, the SDK captures messages in a local inbox.
Receiving Email	Receive mail with handlers in the top-level email/ directory. Inbound handlers require a native SDK app; framework and Node.js, Bun, or Deno builds do not support them.
Email Domains and Setup	Choose the setup for your deployment: register a domain on an SDK platform, or configure email in your own Cloudflare account.
Sandboxes	Use a Cloudflare Sandbox to run commands, work with files, and connect to servers from server code. Each Sandbox ID selects an isolated container.
Cron jobs	Put scheduled jobs in crons/. Each file declares a cron expression and a handler, and the SDK configures the schedule when you deploy.
Queues	Use queues to process work asynchronously, such as sending emails or handling uploads. Define a consumer in queues/, then send it typed messages from your app.
WebSockets	Create a .ws.ts route to send typed messages between your server and connected clients.
Server-sent events	Use void/sse to stream events from a route handler to the browser. The SDK formats messages, sends keepalives, and closes the stream when the request ends.
Live event streams	void/live lets a browser subscribe to several topics over one SSE connection.
How tools are built	Where each on-site tool lives in the repo, and the checklist for adding a new one.
Cursor and agents	How this repo uses Cursor cloud agents and Bugbot, and how secrets are handled.
Related sites	implemented.stream and devstack.bid are separate products with separate repos and deploys.

Next steps

NextBuild this sitePreviousBrand & logo