Getting Started
The fastest way to start a new Jant site is `create-jant`. It scaffolds a Cloudflare-ready project, generates a local `AUTH_SECRET`, installs dependencies by default, and gives you a working local development setup.
If you want to evaluate Jant without creating a project first, skip to Deploy with Docker.
Prerequisites
- Node.js 24 or newer
- A Cloudflare account if you plan to deploy on Workers
Create a New Site
npm create jant@latest my-site
cd my-site
If you prefer pnpm or yarn, use their create command instead. Jant adapts the scaffolded scripts to the package manager you used.
Start Local Development
npm run dev
Open http://localhost:3000.
To use a different local port:
PORT=3030 npm run dev
Complete Setup in the Browser
On first launch, Jant walks you through the initial site setup.
- Create your admin account
- Set your site name
- Choose your language
After that, you can start publishing immediately.
Understand the Default Publishing Model
Before you write the first few posts, one default is worth knowing:
/feedpoints toFeaturedby default/feed/latestexists separately for the latest public postsHidden from Latestlets a post stay public on your site without entering that stream
That split is intentional. In Jant, publishing something and broadcasting it are not automatically the same action.
What the Scaffold Already Did
By default, create-jant also:
- generated
.dev.varswith a secure localAUTH_SECRET - installed dependencies
- initialized a git repository
- created a Cloudflare Workers project with D1 and R2 bindings ready to configure
- included
examples/agent-content-automation/README.mdplus site-level agent guidance for scripted publishing
If you passed --no-install or --no-git, do those steps yourself.
What to Read Next
- Writing and Organizing Posts to understand notes, links, quotes, threads, and collections
- Deploy on Cloudflare to publish the site you just created
- Configuration to tune URLs, storage, feeds, and uploads
- Theming to change how the site looks