# Nextly documentation

Nextly is an open-source content platform for Next.js. MIT licensed, self-hosted. Runs inside your own Next.js app, on your own PostgreSQL or MySQL database, or SQLite for local work.

## Start here

**npm**

```bash
npx create-nextly-app@alpha my-app -y
cd my-app
npm run dev
```

**pnpm**

```bash
pnpm create nextly-app@alpha my-app -y
cd my-app
pnpm dev
```

**yarn**

```bash
yarn create nextly-app@alpha my-app -y
cd my-app
yarn dev
```

**bun**

```bash
bun create nextly-app@alpha my-app -y
cd my-app
bun run dev
```

1. **Create.** A project with the admin and a database.
2. **Start.** The first run creates the system tables.
3. **Sign in.** Open [http\://localhost:3000/admin/setup](http://localhost:3000/admin/setup) and create the first admin.

`-y` takes the defaults: the blank template, SQLite, local storage and the Nextly agent skills. Leave it off to choose a template and a database. The [Quick start](https://nextlyhq.com/docs/getting-started/quick-start.md) goes through each step and what you should see.

Needs Node.js 22.12+ or 24+ (Node 24 LTS recommended) and a Next.js App Router app. [Requirements](https://nextlyhq.com/docs/getting-started/installation.md#requirements) lists the supported Next.js and React versions.

## Other ways in

* **An existing Next.js app.** Run `create-nextly-app` inside an existing Next.js app to add Nextly; it writes only the files the app does not have and extends the Next config. See [Add to an existing Next.js project](https://nextlyhq.com/docs/getting-started/installation.md#option-b-add-to-an-existing-nextjs-project).
* **With a coding agent.** Every new Nextly project ships with an AGENTS.md and CLAUDE.md written for coding agents. New Nextly projects come with agent skills for building with Nextly (installing it, collections, authentication, deploying), written to `.agents/skills/` and `.claude/skills/`. `create-nextly-app` asks first, `-y` adds them, and `--no-skills` leaves them out. See [Coding agents](https://nextlyhq.com/docs/guides/coding-agents.md).
* **Learn the model first.** Model content in TypeScript or in the Visual Schema Builder. Both feed the same Nextly runtime, admin and APIs, with [the differences between them](https://nextlyhq.com/docs/schema-builder.md#builder-vs-code-first). See [Getting Started](https://nextlyhq.com/docs/getting-started.md) for collections, singles, fields and field groups.

## The docs

* **Model:** [Configuration](https://nextlyhq.com/docs/configuration.md) · [Visual Schema Builder](https://nextlyhq.com/docs/schema-builder.md) · [Database](https://nextlyhq.com/docs/database.md) · [Direct API](https://nextlyhq.com/docs/api-reference/direct-api.md) · [REST API](https://nextlyhq.com/docs/api-reference/rest-api.md)
* **Operate:** [Localization](https://nextlyhq.com/docs/localization.md) · [Version history](https://nextlyhq.com/docs/versions.md) · [Content Releases](https://nextlyhq.com/docs/releases.md) · [Roles and permissions](https://nextlyhq.com/docs/permissions.md) · [Preview](https://nextlyhq.com/docs/preview.md)
* **Extend:** [Plugins](https://nextlyhq.com/docs/plugins.md) · [Visual Page Builder](https://nextlyhq.com/docs/page-builder.md) · [Webhooks](https://nextlyhq.com/docs/webhooks.md) · [Background jobs](https://nextlyhq.com/docs/jobs.md) · [Dashboard widgets](https://nextlyhq.com/docs/widgets.md)
* **Ship:** [Deployment](https://nextlyhq.com/docs/guides/deployment.md) · [Production migrations](https://nextlyhq.com/docs/guides/production-migrations.md) · [Media storage](https://nextlyhq.com/docs/guides/media-storage.md) · [Plugin stability](https://nextlyhq.com/docs/plugins/stability.md)

Nextly is in alpha. APIs may change before 1.0. Pin exact versions in production.
