Framework
payloadcms/payload avatar
payloadcms/payload

Payload CMS: create-payload-app, one-click deploys, and v4 in beta

GitHub describes it as Payload is the open-source, fullstack Next.js framework, giving you instant backend superpowers. Get a full TypeScript backend and admin panel instantly. Use Payload as a headless CMS or for building powerful applications.. The repository metadata lists TypeScript as its primary language. The metadata lists the MIT license. This article stays within the project description and details documented in the GitHub repository README.

45,804 stars4,429 forksTypeScriptMIT

At a glance

What is it?
Payload is an MIT-licensed fullstack Next.js framework that gives you a typed backend and an admin panel in the same app folder. Its own repository files are where the interesting decisions sit: fourteen database values in the repository's example environment file, two one-click deploy targets that hand you different databases, a scaffold that lives in a /app folder, and a v4 line shipping as beta builds while v3.92 carries the stable releases.
Who is it for?
Choose Payload when you want a typed backend and an admin panel inside the same Next.js app folder, and when you are willing to let the framework own your data model instead of bolting a CMS onto a separate frontend. Do not choose it if you need a documented v3 to v4 upgrade path, or a runtime other than Next.js today, because the README links a migration guide only for v2 to v3 and the examples already include Astro, Remix and a TanStack app.
Can I use it commercially?
Yes. MIT is a permissive licence: you can use, modify and sell software built on it, as long as you keep its copyright and licence notices.
Is it still maintained?
Yes. The repository last received commits 2 days ago.
What is it written in?
Mainly TypeScript, according to GitHub's language statistics.

Answers come from the project's GitHub data, last synced on November 13, 2026, and from our analysis. They are not legal advice.

From daily snapshots

Star history

  • payloadcms/payload45,804 ★ · +1,685
Star history
Repository2026-08-132026-11-13
payloadcms/payload44.1k45.8k

1,685 Stars in the last 92 days, measured from the daily GitHub snapshot. Compare with other projects

Editorial analysis

The scaffold is pnpx create-payload-app, and the examples runner is npx

There is one way in, and it is a generator rather than a library add:

text
pnpx create-payload-app@latest

The README steers newcomers to the website template, passed as a flag to the same command, and describes it as the one that shows how to do everything, including custom rich text blocks, on-demand revalidation and live preview, with a Tailwind frontend in the same /app folder. What it does not include is a prerequisite list you can read locally: the setup step is a link to the installation page in the documentation, so the Node version and database tooling you need are described on a website rather than in the repository.

The examples work differently, and the difference is easy to miss because the package runner changes:

sh
npx create-payload-app --example example_name

One command uses pnpx and the other uses npx, and the second takes a name from the examples directory rather than a template name. There are thirteen example directories in the tree, covering auth, custom components, a custom server, draft preview, email, a form builder, live preview, localization, multi-tenant, Tailwind with shadcn/ui and a whitelabel setup, plus Astro and Remix. None of them is a starting point for a plain content site, so the website template remains the default choice.

PAYLOAD_DATABASE is one variable with fifteen values behind it

The repository's own .env.example, which points at payloadtests databases and so appears to serve the monorepo's tests and development, names fourteen adapter values in a single line:

yaml
# Database adapters: mongodb, mongodb-atlas, cosmosdb, documentdb, firestore, postgres, postgres-custom-schema, postgres-uuid, postgres-read-replica, vercel-postgres-read-replica, sqlite, sqlite-uuid, supabase, d1
PAYLOAD_DATABASE=mongodb

The default in that file is MongoDB, which is worth knowing before you assume a Postgres project. Each adapter is also a separately built package in the monorepo, with its own turbo target for db-mongodb, db-postgres, db-sqlite, db-d1-sqlite and db-vercel-postgres, so a Postgres deployment never has to install the MongoDB driver and the choice is a real dependency decision rather than a runtime flag.

Two entries in that list carry more than a name. The read-replica variants need a second connection string, and the example file shows it, with the replica reachable on port 5434 when the project's Docker profile starts it. So a replica topology costs you a second environment variable and a second database to provision.

The two one-click deploys hand you different databases and different storage

The README offers one-click serverless deployment on two platforms, and the two are not variations on the same thing. The Cloudflare path deploys Payload with Workers, R2 for uploads and D1 described as a globally replicated database. The Vercel path deploys a Next.js frontend, a Neon database and Vercel Blob for media storage.

Read that as a platform decision rather than a hosting preference. A one-click deployment chooses your database engine and your object storage for you, and both are named products with their own constraints: R2 against Vercel Blob, D1 against Neon. Moving a project from one to the other later means changing the adapter and the upload plugin, not just moving a DNS record. The project also states that you can deploy anywhere, including serverlessly on Vercel for free, which puts cost in the pitch without stating any limits, so the free path is worth measuring against your own traffic rather than assuming.

For self-hosting, none of this applies; the README says you can deploy anywhere.

The README calls Payload Next.js native, and the monorepo already holds app-tanstack

The headline claim is that Payload is the first Next.js native CMS, installable directly into an existing /app folder. The repository says something more complicated. There is an app-tanstack directory beside app at the top level, the turbo build filters reference both blank and blank-tanstack templates, and the examples directory contains Astro and Remix projects alongside a custom-server example.

None of that contradicts the default, which is still a Next.js app, but it does change what the positioning means. Next.js native describes the path of least resistance rather than a boundary, and a framework that installs into your app folder is by construction coupled to that folder's runtime. If you are on Astro, Remix or something else, the interesting question is which of those is supported at which version.

The custom-server example is the one that changes the deployment story rather than the runtime story: it suggests Payload can run as its own server instead of only inside a Next.js application, which is the shape you want when the frontend is not Next.js at all.

v4 is shipping as canary.37 while v3.90.x carries the stable tags

The newest releases are two different product lines. v3.92.1 was published on 2026-10-27 as a stable patch, v4.0.0-beta.5 appeared the same day, and v4.0.0-beta.6 followed on 2026-10-29. The repository's own package.json sits at 4.0.0-beta.6, so the v4 line is in public beta.

For an adopter, the practical effect is that two lines move within days of each other and you have to choose deliberately. Pin a v3 tag if you want stability, and accept that you are choosing the line whose migration story is already written. The README points migrating users at the 3.0 Migration Guide for going from v2 to v3, and it links no equivalent guide for v3 to v4.

The licence is MIT in LICENSE.md, so the code carries no copyleft obligation either way.

payload-types.ts is committed, so a schema change is a diff you review

Payload generates TypeScript types for your data, and the generated file is committed at the repository root as payload-types.ts. That single fact shapes how development feels. A field added to a collection produces a change in a file you did not write, which lands in your pull request as a large mechanical diff, and it is the clearest signal available that a schema edit landed where you thought it did.

The tooling around that is worth knowing before you contribute. tstyche.json at the top level means types are themselves under test, so a change that breaks the generated types fails a check that never runs your code. The compiler is SWC rather than Babel, configured in .swcrc, and instrumentation.ts plus sentry.client.config.ts and sentry.server.config.ts show error reporting wired into both the client and the server side. Builds run through turbo over a pnpm workspace of packages/* and test/*, with a release.config.js at the root driving releases.

Consequence for an outside contributor: the toolchain is pnpm plus turbo, not npm, and a first build compiles a large workspace before you have changed anything.

Plugins can remove functionality, which moves the floor under your admin panel

Extensibility runs through the admin panel as well as the API. Plugins may add or remove functionality, and the project splits them into officially-supported and community-supported, discoverable through the payload-plugin topic on GitHub. The admin is described as a customizable React app, access control is granular down to the document and field, and there are hooks for every action the framework provides.

That combination is the reason people stay, and it is also the source of the maintenance question. Your app's behaviour is the core plus whatever packages you installed, and those packages move on their own schedules with their own peer ranges against the framework. A core upgrade can therefore change behaviour through a plugin rather than through your code, so the honest answer is that you test the combination you actually ship.

The practical rule is narrower than the marketing: prefer official plugins where they exist, treat a community plugin as code you own, and read its peer range before every core upgrade rather than after.

Server components replace the API layer, and other clients are unaddressed

One of the feature bullets says you can query your database directly in server components, with no need for REST or GraphQL, and another says the admin and backend are fully extensible. Together they describe a world where the frontend and the data share one process, which is the strongest argument for the framework.

If every reader is React code inside your app folder, that is exactly the right design. If something else has to read your content, a phone app, a partner integration, a script, then the server-component path does not serve it. The README does not spell out here which API surfaces a project exposes, so check the documentation before you commit.

Authentication is part of the same boundary. The security story is built on HTTP-only cookies and CSRF protection, which is a browser session model. A non-browser client does not fit a browser session model neatly, so plan for that before you promise an API to anyone outside the app.

Editorial conclusion

Choose Payload when you want a typed backend and an admin panel inside the same Next.js app folder, and when you are willing to let the framework own your data model instead of bolting a CMS onto a separate frontend. Do not choose it if you need a documented v3 to v4 upgrade path, or a runtime other than Next.js today, because the README links a migration guide only for v2 to v3 and the examples already include Astro, Remix and a TanStack app. Verify two things before committing: which database adapter your deploy target supports, since one one-click path hands you D1 and the other Neon, and which build you are on, since the newest v4 tag is a beta published within days of the v3.92 patch.

Frequently asked questions

How do I use Payload CMS?

Start with the generator, which creates a project rather than adding a library: pnpx create-payload-app@latest. The README recommends the website template for newcomers, passed as -t website, because it demonstrates custom rich text blocks, on-demand revalidation, live preview and a Tailwind frontend inside the same /app folder, and the documentation site carries the rest of the setup steps.

How do I install Payload?

The install step is a single generator command, pnpx create-payload-app@latest, and the required software is listed in the installation page the README links to rather than in the repository. Examples can be started the same way with npx create-payload-app --example example_name, which takes a name from the examples directory.

Which databases does Payload support?

The repository's example environment file lists fourteen database values for the PAYLOAD_DATABASE variable: mongodb, mongodb-atlas, cosmosdb, documentdb, firestore, postgres, postgres-custom-schema, postgres-uuid, postgres-read-replica, vercel-postgres-read-replica, sqlite, sqlite-uuid, supabase and d1, with mongodb as the default in that file. The monorepo builds separate packages for db-mongodb, db-postgres, db-sqlite, db-d1-sqlite and db-vercel-postgres.

Can I deploy Payload to Vercel or Cloudflare?

Yes, through one-click deployments, and the two paths differ. The Vercel option deploys a Next.js frontend with a Neon database and Vercel Blob for media, while the Cloudflare option deploys with Workers, R2 for uploads and D1 as the database. The README also states you can deploy anywhere, including serverlessly on Vercel for free.

How do I migrate from Payload v2 to v3?

The README points migrating users at the 3.0 Migration Guide, which lives in the repository as docs/migration-guide/overview.mdx. The README links no equivalent guide for v3 to v4. The v4 line is in beta (v4.0.0-beta.6 on 2026-10-29), while v3.92.1 is the latest stable release listed.

Official sources

  1. Official documentation
  2. Official README
  3. Project repository
  4. Release notes
Community

Where developers are discussing it

Posts on Hacker News, dev.to and Lobsters that link to this repository, found by our scan of those communities. 0 in the last 30 days; newest first.

  • Payload CMSHacker News · Oct 6, 2026 · 1 points · 0 comments
Add this badge to your README

If you maintain this project, the badge below links readers to this analysis and shows its maintenance status from the daily GitHub snapshot. Paste the markdown into your README; add ?metric=license or ?metric=stars to the image URL for a different field.

Add this badge to your README

markdown
[![Hysen Labs](https://hysenlabs.com/badge/payloadcms-payload.svg)](https://hysenlabs.com/projects/payloadcms-payload)

Star history chart for your README

markdown
[![Star history](https://hysenlabs.com/chart/payloadcms-payload.svg)](https://hysenlabs.com/projects/payloadcms-payload)

Was this useful?