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 — это фреймворк с открытым исходным кодом на TypeScript, построенный на Next.js. Он сразу даёт полноценный бэкенд и панель администратора и может использоваться как headless CMS или как бэкенд для любого приложения.
Это headless CMS или фреймворк для полноценных приложений?И то, и другое. Payload устанавливается прямо в существующую папку /app вашего проекта на Next.js, поэтому можно объединить фронтенд и бэкенд в одном проекте или использовать его только как headless CMS за отдельным фронтендом.
Как запустить проект?Создайте новый проект через CLI: 'pnpx create-payload-app@latest -t website'. Команда развернёт готовый сайт с Tailwind, блоками Rich Text, предпросмотром в реальном времени и ревалидацией по требованию.
Какая база данных и какой стек нужны?Payload работает на Node.js с фронтендом на Next.js и подключается к MongoDB или Postgres как к базе данных. Под капотом также используется Express.
Меня привязывают к Vercel или к конкретному хостингу?Нет. Payload полностью открытый и не создаёт привязки к поставщику. Хотя есть деплой в один клик на Vercel и Cloudflare, его можно развернуть на собственном сервере где угодно.
Для кого создан Payload, в отличие от традиционной CMS вроде WordPress?Для разработчиков, которым нужен полный контроль над слоем контента на TypeScript без устаревшего кода CMS и без привязки к SaaS-сервису.
Что входит в Payload из коробки?Аутентификация, версионирование и черновики, локализация, конструктор макетов на основе блоков, гранулярный контроль доступа и хуки на уровне документов и полей. Всё это включено без дополнительных плагинов.
Можно ли напрямую запрашивать базу данных из React-компонентов?Да. Payload позволяет запрашивать базу данных прямо из React Server Components, без обращения через REST или GraphQL.
Что такое редактор форматированного текста?Payload использует Lexical как встроенный редактор форматированного текста для панели администратора.
Можно ли расширять или настраивать панель администратора?Да. И интерфейс администратора, и бэкенд полностью расширяемы. С помощью серверных компонентов можно расширять сам интерфейс панели администратора Payload.
Creator
payloadcms
Size
228 MB
Stars
45.3K
Age
5y
Commits · 90 Days