Getting Started

Create a Farm.js app, understand the files that matter, and run the development server.

Create an app

Farm keeps the first project small: an app directory, a config file, package metadata, and TypeScript. Vite config and platform config are optional escape hatches, not required setup.

pnpm create farm-app my-appcd my-apppnpm installpnpm dev

What you get

• File-based routes in src/app.
• React rendering with pages, layouts, loading, error, and not-found boundaries.
• Typed Link hrefs generated from the route tree.
• API routes and a generated client for api.users.get style calls.
• Deployment output powered by Farm config instead of extra root files.

Your first page

import type { PageProps } from "@farmjs/core";export default function HomePage(_props: PageProps) {  return <h1>Hello from Farm.js</h1>;}

Add a layout

Every route can share chrome through layout.tsx. Start with a root layout, then add nested layouts only when a section needs its own navigation or data shell.

import type { LayoutProps } from "@farmjs/core";import "./globals.css";export default function RootLayout({ children }: LayoutProps) {  return (    <main>      <header>Farm.js</header>      {children}    </main>  );}

Add an API route

Farm API routes live beside pages and use the same route tree. Define an endpoint, add Zod input when needed, then call it through the generated API client.

import { createEndpoint } from "@farmjs/core/api";import { z } from "zod";export const POST = createEndpoint(  {    method: "POST",    body: z.object({      name: z.string().min(1),    }),  },  async ({ body }) => {    return Response.json({      message: `Hello ${body.name}`,    });  },);

"use client";import { apiClient } from "@/lib/api";export function HelloButton() {  return (    <button      onClick={async () => {        const result = await apiClient.hello.post({          body: { name: "Ada" },        });        console.log(result.data?.message);      }}    >      Say hello    </button>  );}

Add integrations later

Keep the first app small. When a feature becomes provider-shaped, add it as an integration:

farm add integration stripe --uifarm add integration better-auth --uifarm add integration unkey

Integrations can contribute typed callers, routes, providers, middleware, storage schema, CLI registry components, config validation, and lifecycle hooks.

Next steps

• Read Project Structure when you want the compact file layout.
• Read Routing and Layouts when you start nesting pages.
• Read API Routes and API Client when you need typed server/client calls.
• Read Integrations when provider features should be packaged instead of copied route-by-route.