Documentation Index
Fetch the complete documentation index at: https://veryfront.com/docs/llms.txt
Use this file to discover all available pages before exploring further.
Production path
Build one Veryfront route from local project to production verification.
Use this guide when you want the shortest complete path through the docs:
create a project, choose the right primitive, add one user-visible surface, then
prove the same app works in production.
Prerequisites
- The current Node.js LTS.
- A terminal that can run the Veryfront CLI.
- Production credentials for any provider, integration, or deployment target
your project uses.
Path overview
| Step | Goal | Guide |
|---|
| 1 | Create and run a local app. | Quickstart |
| 2 | Pick the smallest primitive for the work. | Choose a primitive |
| 3 | Add the user-visible route or API boundary. | Pages and routing, API routes |
| 4 | Add the primitive only when the route needs it. | Agents, Tools, Workflows, Tasks |
| 5 | Build, run, and deploy the production app. | Building and deploying |
Create the project
Start from a template that matches the product shape you want to test.
veryfront init production-path --template minimal
cd production-path
veryfront dev
http://localhost:3000 and keep the dev server running while you add the
first route.
Choose the primitive
Before adding an agent, workflow, job, or integration, check the smallest
matching primitive:
| Need | Start with |
|---|
| Render UI or content | Page |
| Return HTTP data | API route |
| Let a model use typed capability | Tool |
| Run a conversational model | Agent |
| Coordinate multiple steps | Workflow |
| Run background or scheduled work | Task, job, or cron job |
Add one route boundary
Pick one boundary and make it observable in both dev and production.
| Boundary | Add | Verify locally |
|---|
| Page | app/page.tsx or another route under app/ | Open the route in the browser. |
| API route | app/api/<name>/route.ts | Run curl http://localhost:3000/api/<name>. |
| Agent chat | Page plus app/api/ag-ui/route.ts | Send one message and confirm streamed output. |
| Workflow or task trigger | API route or CLI command | Trigger one run and inspect the result. |
Build and run production locally
Stop the dev server, then run the production build locally:
veryfront build
veryfront start
http://localhost:3000 again and test the same route or API endpoint you
tested in dev.
Deploy
Deploy after the local production server matches the dev behavior:
For a non-Cloud target, use the build output from veryfront build and follow
the target host’s runtime requirements.
Verify it worked
Use the same checks at each stage:
| Stage | Check |
|---|
| Dev | veryfront dev prints a local URL and the route responds. |
| Local production | veryfront build exits successfully and veryfront start serves the same route. |
| Deployed production | veryfront deploy completes, then veryfront open opens the deployed route. |
curl. For pages,
open the same path in both environments. Use veryfront open --json when you
need the deployed URL for scripts or a terminal-only check. For agents,
workflows, tasks, jobs, or integrations, trigger one minimal run and confirm the
expected output or status.
Next
