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.
> /plugin marketplace add payloadcms/payload> /plugin install payload@payload-marketplace
Repo: payloadcms/payload
What's inside
[!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.
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.
You can deploy Payload serverlessly in one-click via Vercel and Cloudflareโgiving everything you need without the hassle of the plumbing.
Fully self-contained โ one click to deploy Payload with Workers, R2 for uploads, and D1 for a globally replicated database.
All-in-one on Vercel โ one click to deploy Payload with a Next.js front end, Neon database, and Vercel Blob for media storage.
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.
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:
/app folderRequest Feature
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.
If you want to add contributions to this repository, please follow the instructions in contributing.md.
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:
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.
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:
.claude/
.claude-plugin/
marketplace.json
commands/
analyze-issue.md
respond-to-discussion-features.md
triage.md
hooks/
post-write-format.sh
settings.json
skills/
audit-dependencies/
SKILL.md
generate-translations/
SKILL.md
triage-ci-flake/
SKILL.md
ui4/
ui4-convert-tests/
SKILL.md
ui4-review/
SKILL.md
SKILL.md
.codex/
config.toml
.cursor/
mcp.json
.devcontainer/
.env.example
devcontainer.json
setup.sh
.editorconfig
.env.example
.git-blame-ignore-revs
.gitattributes
.github/
actions/
activity/
dist/
new-issues/
index.js
popular-issues/
index.js
package.json
pnpm-lock.yaml
src/
index.ts
lib/
utils.ts
new-issues.ts
popular-issues.ts
types.ts
tsconfig.json
ai-reviewer/
action.yml
dist/
933.index.js
index.js
package.json
src/
diff.test.ts
diff.ts
github.ts
index.ts
providers/
anthropic.test.ts
anthropic.ts
types.ts
review.test.ts
review.ts
sanitize.test.ts
sanitize.ts
tsconfig.json
vitest.config.ts
release-commenter/
.eslintrc.js
action.yml
dist/
index.js
jest.config.js
LICENSE
package.json
pnpm-lock.yaml
README.md
src/
__snapshots__/
index.test.ts.snap
index.test.ts
index.ts
tsconfig.json
setup/
action.yml
start-services/
action.yml
triage/
action.yml
dist/
index.js
jest.config.js
LICENSE
package.json
pnpm-lock.yaml
README.md
src/
index.ts
tsconfig.json
ai-reviewer-prompt.md
assets/
e2e-debug.png
int-debug.png
CODEOWNERS
comments/
invalid-reproduction.md
dependabot.yml
ISSUE_TEMPLATE/
1.bug_report_v3.yml
2.design_issue.yml
config.yml
DOCUMENTATION_ISSUE.md
pnpm-lock.yaml
pnpm-workspace.yaml
PULL_REQUEST_TEMPLATE.md
reproduction-guide.md
workflows/
activity-notifications.yml
ai-reviewer.yml
audit-dependencies.sh
audit-dependencies.yml
dispatch-event.yml
e2e.config.ts
int.config.ts
label-on-change.yml
lock-issues.yml
main.yml
notify-next-canary.yml
post-release-templates.yml
post-release.yml
pr-title.yml
publish-prerelease.yml
publish-release.yml
release-bump.yml
stale.yml
triage.yml
utilities/
e2e-matrix.ts
int-matrix.ts
wait-until-package-version.sh
.gitignore
.husky/
pre-commit
.idea/
payload.iml
runConfigurations/
Run_Dev__community.xml
Run_Dev_admin.xml
Run_Dev_Fields.xml
.lintstagedrc.mjs
.mcp.json
.node-version
.nvmrc
.prettierignore
.prettierrc.json
.stylelint/
no-important.js
no-max-width-media-query.js
no-non-standard-breakpoints.js
no-subpixel-values.js
no-tilde-imports.js
.stylelintrc.json
.swcrc
.tool-versions
.vscode/
extensions.json
launch.json
mcp.json
settings.json
AGENTS.md
app/
app-tanstack/
app/
__root.tsx
_payload/
_payload.tsx
admin.$.tsx
admin.index.tsx
api.$.ts
server.functions.ts
custom.css
index.tsx
router.tsx
tsconfig.json
(app)/
layout.tsx
test/
page.tsx
(payload)/
admin/
[[...segments]]/
not-found.tsx
page.tsx
api/
[...slug]/
route.ts
graphql/
graphql-playground/
route.ts
route.ts
custom.css
layout.tsx
themes/
steam.css
global-error.tsx
my-route/
route.ts
CLAUDE.md
CONTRIBUTING.md
docs/
.prettierrc.json
access-control/
collections.mdx
fields.mdx
globals.mdx
overview.mdx
admin/
accessibility.mdx
admin-panel-location.mdx
customizing-css.mdx
locked-documents.mdx
metadata.mdx
overview.mdx
preferences.mdx
preview.mdx
react-hooks.mdx
authentication/
api-keys.mdx
cookies.mdx
custom-strategies.mdx
email.mdx
jwt.mdx
operations.mdx
overview.mdx
server-functions.mdx
token-data.mdx
configuration/
collections.mdx
environment-vars.mdx
globals.mdx
i18n.mdx
localization.mdx
overview.mdx
custom-components/
custom-providers.mdx
custom-views.mdx
dashboard.mdx
document-views.mdx
edit-view.mdx
list-view.mdx
overview.mdx
root-components.mdx
database/
indexes.mdx
migrations.mdx
mongodb.mdx
overview.mdx
postgres.mdx
sqlite.mdx
transactions.mdx
ecommerce/
advanced.mdx
frontend.mdx
overview.mdx
payments.mdx
plugin.mdx
email/
overview.mdx
examples/
overview.mdx
fields/
array.mdx
blocks.mdx
checkbox.mdx
code.mdx
collapsible.mdx
date.mdx
email.mdx
group.mdx
join.mdx
json.mdx
number.mdx
overview.mdx
point.mdx
radio.mdx
relationship.mdx
rich-text.mdx
row.mdx
select.mdx
slug.mdx
tabs.mdx
text.mdx
textarea.mdx
ui.mdx
upload.mdx
folders/
overview.mdx
getting-started/
ai-tooling.mdx
concepts.mdx
installation.mdx
use-cases.mdx
what-is-payload.mdx
graphql/
extending.mdx
graphql-schema.mdx
overview.mdx
hierarchy/
overview.mdx
hooks/
collections.mdx
context.mdx
fields.mdx
globals.mdx
overview.mdx
integrations/
vercel-content-link.mdx
jobs-queue/
jobs.mdx
overview.mdx
queues.mdx
quick-start-example.mdx
schedules.mdx
tasks.mdx
workflows.mdx
live-preview/
client.mdx
frontend.mdx
overview.mdx
server.mdx
local-api/
access-control.mdx
outside-nextjs.mdx
overview.mdx
server-functions.mdx
migration-guide/
overview.mdx
v3.mdx
v4.mdx
performance/
overview.mdx
plugins/
build-your-own.mdx
form-builder.mdx
import-export.mdx
mcp.mdx
multi-tenant.mdx
nested-docs.mdx
overview.mdx
plugin-api.mdx
redirects.mdx
search.mdx
sentry.mdx
seo.mdx
stripe.mdx
production/
building-without-a-db-connection.mdx
deployment.mdx
preventing-abuse.mdx
queries/
depth.mdx
overview.mdx
pagination.mdx
select.mdx
sort.mdx
query-presets/
overview.mdx
rest-api/
overview.mdx
rich-text/
blocks.mdx
converters.mdx
converting-html.mdx
converting-jsx.mdx
converting-markdown.mdx
converting-plaintext.mdx
custom-features.mdx
official-features.mdx
overview.mdx
rendering-on-demand.mdx
views.mdx
trash/
overview.mdx
troubleshooting/
troubleshooting.mdx
typescript/
generating-types.mdx
overview.mdx
ts-plugin.mdx
upload/
overview.mdx
storage-adapters.mdx
versions/
... 1600 moreShowing a partial view of a very large repo.
FAQ
payload is a Claude Code plugin with 7 hand-picked skills for development work, indexed on Flowy. Install it with the command on its page. It includes audit-dependencies, generate-translations, triage-ci-flake. Its skills do not fire on their own yet. Request auto-invocation to have Flowy route them as you prompt. Free and open source.