diff --git a/packages/payload/README.md b/packages/payload/README.md index 9b4f39e89d5..bb768668717 100644 --- a/packages/payload/README.md +++ b/packages/payload/README.md @@ -1,72 +1,58 @@ - - Payload headless CMS Admin panel built with React - +Payload headless CMS Admin panel built with React

+

- - GitHub Workflow Status - + GitHub Workflow Status +   + Discord   - - Discord - + npm   - - npm - + npm   - - Payload Twitter - + Payload Twitter

-Explore the Docs · Community Help · Try Live Demo · Roadmap · View G2 Reviews +Explore the Docs · Community Help · Roadmap · View G2 Reviews

> [!IMPORTANT] -> 🎉 Payload 2.0 is now available! Read more in the announcement post. +> 🎉 We've released 3.0! 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

-## ☁️ Deploy instantly with Payload Cloud. - -Create a cloud account, connect your GitHub, and [deploy in minutes](https://payloadcms.com/new). - -## 🚀 Get started by self-hosting completely free, forever. +## Quickstart Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation). ```text -npx create-payload-app@latest +pnpx create-payload-app@latest ``` -Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch). +**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 templates +## One-click templates Jumpstart your next project by starting with a pre-made template. These are production-ready, end-to-end solutions designed to get you to market as fast as possible. -### [🛒 E-Commerce](https://github.com/payloadcms/payload/tree/main/templates/ecommerce) - -Eliminate the need to combine Shopify and a CMS, and instead do it all with Payload + Stripe. Comes with a beautiful, fully functional front-end complete with shopping cart, checkout, orders, and much more. - ### [🌐 Website](https://github.com/payloadcms/payload/tree/main/templates/website) -Build any kind of website, blog, or portfolio from small to enterprise. Comes with a beautiful, fully functional front-end complete with posts, projects, comments, and much more. +Build any kind of website, blog, or portfolio from small to enterprise. Comes with a fully functional front-end built with RSCs and Tailwind. We're constantly adding more templates to our [Templates Directory](https://github.com/payloadcms/payload/tree/main/templates). If you maintain your own template, consider adding the `payload-template` topic to your GitHub repository for others to find. @@ -76,20 +62,19 @@ We're constantly adding more templates to our [Templates Directory](https://gith ## ✨ Features - Completely free and open-source -- [GraphQL](https://payloadcms.com/docs/graphql/overview), [REST](https://payloadcms.com/docs/rest-api/overview), and [Local](https://payloadcms.com/docs/local-api/overview) APIs -- [Easily customizable ReactJS Admin](https://payloadcms.com/docs/admin/overview) -- [Fully self-hosted](https://payloadcms.com/docs/production/deployment) -- [Extensible Authentication](https://payloadcms.com/docs/authentication/overview) -- [Local file storage & upload](https://payloadcms.com/docs/upload/overview) -- [Version History and Drafts](https://payloadcms.com/docs/versions/overview) -- [Field-based Localization](https://payloadcms.com/docs/configuration/localization) -- [Block-based Layout Builder](https://payloadcms.com/docs/fields/blocks) -- [Extensible SlateJS rich text editor](https://payloadcms.com/docs/fields/rich-text) -- [Array field type](https://payloadcms.com/docs/fields/array) -- [Field conditional logic](https://payloadcms.com/docs/fields/overview#conditional-logic) +- Next.js native, built to run inside _your_ `/app` folder +- Use server components to extend Payload UI +- Query your database directly in server components, no need for REST / GraphQL +- Fully TypeScript with automatic types for your data +- [Auth out of the box](https://payloadcms.com/docs/authentication/overview) +- [Versions and drafts](https://payloadcms.com/docs/versions/overview) +- [Localization](https://payloadcms.com/docs/configuration/localization) +- [Block-based kayout builder](https://payloadcms.com/docs/fields/blocks) +- [Customizable React admin](https://payloadcms.com/docs/admin/overview) +- [Lexical rich text editor](https://payloadcms.com/docs/fields/rich-text) +- [Conditional field logic](https://payloadcms.com/docs/fields/overview#conditional-logic) - Extremely granular [Access Control](https://payloadcms.com/docs/access-control/overview) - [Document and field-level hooks](https://payloadcms.com/docs/hooks/overview) for every action Payload provides -- Built with Typescript & very Typescript-friendly - Intensely fast API - Highly secure thanks to HTTP-only cookies, CSRF protection, and more @@ -99,7 +84,7 @@ We're constantly adding more templates to our [Templates Directory](https://gith Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers. -Migrating from v1 to v2? Check out the [2.0 Release Notes](https://github.com/payloadcms/payload/releases/tag/v2.0.0) on how to do it. +Migrating from v2 to v3? Check out the [3.0 Migration Guide](https://github.com/payloadcms/payload/blob/main/docs/migration-guide/overview.mdx) on how to do it. ## 🙋 Contributing @@ -109,6 +94,10 @@ If you want to add contributions to this repository, please follow the instructi The [Examples Directory](./examples) 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 either copy them to a folder outside this repo or run them directly by (1) navigating to the example's subfolder (`cd examples/your-example-folder`) and (2) using the `--ignore-workspace` flag to bypass workspace restrictions (e.g., `pnpm --ignore-workspace install` or `pnpm --ignore-workspace dev`). + +You can see more examples at: + - [Examples Directory](./examples) - [Payload Blog](https://payloadcms.com/blog) - [Payload YouTube](https://www.youtube.com/@payloadcms)