payload README

The project's README from github.com/payloadcms/payload. As one markdown file: README.md.

Payload headless CMS Admin panel built with React

GitHub Workflow Status   Discord   npm   npm   npm   Payload Twitter


Explore the Docs · Community Help · Roadmap · View G2 Reviews


[!IMPORTANT] Star this repo or keep an eye on it to follow along.

Payload is the first-ever Next.js native CMS that can install directly in your existing /app folder. It's the start of a new era for headless CMS.

Benefits over a regular CMS

Quickstart

Before beginning to work with Payload, make sure you have all of the required software.

pnpx create-payload-app@latest

If you're new to Payload, you should start with the website template (pnpx create-payload-app@latest -t website). It shows how to do everything - including custom Rich Text blocks, on-demand revalidation, live preview, and more. It comes with a frontend built with Tailwind all in one /app folder.

One-click deployment options

You can deploy Payload serverlessly in one-click via Vercel and Cloudflare—giving everything you need without the hassle of the plumbing.

Deploy on Cloudflare

Fully self-contained — one click to deploy Payload with Workers, R2 for uploads, and D1 for a globally replicated database.

Deploy to Cloudflare

Deploy on Vercel

All-in-one on Vercel — one click to deploy Payload with a Next.js front end, Neon database, and Vercel Blob for media storage.

Deploy with Vercel

One-click templates

Jumpstart your next project with a ready-to-go template. These are production-ready, end-to-end solutions designed to get you to market fast. Build any kind of website, ecommerce store, blog, or portfolio — complete with a modern front end built using React Server Components and Tailwind.

🌐 Website

🛍️ Ecommerce 🎉 NEW 🎉

We're constantly adding more templates to our Templates Directory. If you maintain your own, add the payload-template topic to your GitHub repo so others can discover it.

🔗 Explore more:

✨ Payload Features

Request Feature

🗒️ Documentation

Check out the Payload website to find in-depth documentation for everything that Payload offers.

Migrating from v2 to v3? Check out the 3.0 Migration Guide on how to do it.

🙋 Contributing

If you want to add contributions to this repository, please follow the instructions in contributing.md.

📚 Examples

The Examples Directory is a great resource for learning how to setup Payload in a variety of different ways, but you can also find great examples in our blog and throughout our social media.

If you'd like to run the examples, you can use create-payload-app to create a project from one:

npx create-payload-app --example example_name

You can see more examples at:

🔌 Plugins

Payload is highly extensible and allows you to install or distribute plugins that add or remove functionality. There are both officially-supported and community-supported plugins available. If you maintain your own plugin, consider adding the payload-plugin topic to your GitHub repository for others to find.

🚨 Need help?

There are lots of good conversations and resources in our Github Discussions board and our Discord Server. If you're struggling with something, chances are, someone's already solved what you're up against. :point_down:

⭐ Like what we're doing? Give us a star

👏 Thanks to all our contributors

payload (payloadcms/payload)

Searching Database…

45.3K ·GitHub
这是什么?Payload 是一个基于 Next.js 构建的开源全栈 TypeScript 框架,可以立即提供完整的后端和管理后台。它既能作为无头 CMS 使用,也能作为任何应用的后端。
它是无头 CMS,还是完整的应用框架?两者都是。它可以直接安装在现有 Next.js 项目的 /app 文件夹中,因此你可以在同一个项目里同时组合前端和后端;也可以纯粹作为无头 CMS,搭配独立的前端使用。
我该怎么把项目跑起来?用 CLI 创建新项目:'pnpx create-payload-app@latest -t website'。它会搭建一个现成的网站,包含 Tailwind、Rich Text 区块、实时预览和按需重新验证功能。
它需要什么数据库和技术栈?Payload 运行在 Node.js 上,搭配 Next.js 前端,并使用 MongoDB 或 Postgres 作为数据库。其底层还内置了 Express。
我会被绑定到 Vercel 或某个特定主机吗?不会。Payload 完全开源,没有厂商锁定。虽然它支持一键部署到 Vercel 和 Cloudflare,但你也可以将它自托管在任何地方。
和 WordPress 这类传统 CMS 相比,它是为谁设计的?面向那些希望完全用 TypeScript 掌控内容层,又不想背负传统 CMS 遗留代码或 SaaS 锁定的开发者。
Payload 开箱即用自带哪些功能?身份验证、版本与草稿、本地化、基于区块的布局构建器、细粒度访问控制,以及文档级和字段级钩子(hooks),都无需额外插件即可使用。
我能在 React 组件里直接查询数据库吗?可以。Payload 允许你直接在 React Server Components 中查询数据库,无需经过 REST 或 GraphQL。
富文本编辑器是什么?Payload 使用 Lexical 作为管理后台内置的富文本编辑器。
我能扩展或自定义管理后台吗?可以。管理界面和后端都具有 100% 的可扩展性,你还可以使用服务端组件来扩展 Payload 管理界面本身。
Creator
payloadcms
Size
227.7 MB
Stars
45.3K
Age
5y
Commits · 90 Days