Payload 3.0 Alpha Demo

This repo showcases a demo of Payload 3.0 running completely within Next.js.

Important

It's extremely important to note that as of now, this demo contains ALPHA software and you are 100% guaranteed to run into bugs / weird stuff.

We're actively working toward a beta release, and then a full stable release as fast as we possibly can.

Highlights

Payload is now Next.js-native
Turbopack works out of the box (this will get faster over time, expect more here)
The Payload admin UI is built with React Server Components and automatically eliminates server-side code from your admin bundle, completely alleviating the need to use Webpack aliases to remove hooks, access control, etc.
Payload is now fully-ESM across the board
GraphQL is now initialized only when you hit the GraphQL endpoint, and does not affect overhead of REST API routes
All UI components have been abstracted into a separate @payloadcms/ui package, which will be fully documented and exposed for your re-use once we hit stable 3.0 or before
You can run your own Next.js site alongside of Payload in the same app
You can now deploy Payload to Vercel, and there will be official support for Vercel Blob Storage coming soon (so no S3 needed for files)
Server-side HMR works out of the box, with no need for nodemon or similar. When the Payload config changes, your app will automatically re-initialize Payload seamlessly in the background
All custom React components can be server components by default, and you can decide if you want them to be server components or client components
Sharp has been abstracted to be an optional dependency
Payload now relies on the Web Request / Response APIs rather than the Node Request / Response
Express can still be used with Next.js' Custom Server functionality
Payload itself has slimmed down significantly and can now be fully portable, run anywhere. You can leverage the Payload Local API completely outside of Next.js if you want.
The data layer, including the shape of the database Payload used and the API responses in 2.0, has not been affected whatsoever

Work to come

We are making this available to our community so that we can gather your feedback and test the new approach that Payload is taking. Don't expect it to be fully functional yet. There are some things that we are aware of that are not yet completed, but we're going to keep blazing through the remaining items as fast as we can to reach stable 3.0 as quickly and efficiently as possible. Here are a few of the items that we are still working on (not a full list):

beforeDuplicate hooks
The config preview function
Document Duplication
Documentation
Vercel Blob Storage adapter
Lots of bugs for sure
100% of tests passing
Compiler speed improvements (turbo is beta still, it is slower than it should be. it will get faster)
Overall speed improvements
Support for all official plugins
An install script to be able to install Payload easily into any existing Next.js app
A full list of breaking changes for 2.0 -> 3.0, including an in-depth migration guide

Using this repo

To try out this repo yourself, follow the steps below:

Clone the repo to your computer (git clone git@github.com:payloadcms/payload-3.0-alpha-demo.git)
cd into the new folder by running cd ./payload-3.0-alpha-demo
Copy the .env.example by running cp .env.example .env in the repo, then fill out the values including the connection string to your DB
Install dependencies with whatever package manager you use (yarn, npm install, pnpm i, etc.)
Fire it up (yarn dev, npm run dev, pnpm dev, etc.)
Visit https://localhost:3000 and log in with the user created within the config's onInit method

Technical details

The app folder

You'll see that Payload requires a few files to be present in your /app folder. There are files for the admin UI as well as files for all route handlers. We've consolidated all admin views into a single page.tsx and consolidated most of the REST endpoints into a single route.ts file for simplicity, but also for development performance. With this pattern, you only have to compile the admin UI / REST API / GraphQL API a single time - and from there, it will be lightning-fast.

The next.config.js withPayload function

You'll see in the Next.js config that we have a withPayload function installed. This function is required for Payload to operate, and it ensures compatibility with packages that Payload needs such as drizzle-kit, sharp, pino, and mongodb.

Find a bug?

Open an issue at https://github.com/payloadcms/payload with as much detail as you can provide and we will tackle them as fast as we can. Let's get stable!

4.7 KiB Raw Blame History