| title | label | order | desc | keywords |
|---|---|---|---|---|
Installation |
Installation |
30 |
To quickly get started with Payload, simply run npx create-payload-app or install from scratch. |
documentation, getting started, guide, Content Management System, cms, headless, javascript, node, react, nextjs |
Payload requires the following software:
- Any JavaScript package manager (pnpm, npm, or yarn - pnpm is preferred)
- Node.js version 20.9.0+
- Any compatible database (MongoDB, Postgres or SQLite)
To quickly scaffold a new Payload app in the fastest way possible, you can use create-payload-app. To do so, run the following command:
npx create-payload-app
Then just follow the prompts! You'll get set up with a new folder and a functioning Payload app inside. You can then start configuring your application.
Adding Payload to an existing Next.js app is super straightforward. You can either run the npx create-payload-app command inside your Next.js project's folder, or manually install Payload by following the steps below.
If you don't have a Next.js app already, but you still want to start a project from a blank Next.js app, you can create a new Next.js app using npx create-next-app - and then just follow the steps below to install Payload.
First, you'll want to add the required Payload packages to your project and can do so by running the command below:
pnpm i payload @payloadcms/next @payloadcms/richtext-lexical sharp graphqlNext, install a Database Adapter. Payload requires a Database Adapter to establish a database connection. Payload works with all types of databases, but the most common are MongoDB and Postgres.
To install a Database Adapter, you can run one of the following commands:
-
To install the MongoDB Adapter, run:
pnpm i @payloadcms/db-mongodb
-
To install the Postgres Adapter, run:
pnpm i @payloadcms/db-postgres
-
To install the SQLite Adapter, run:
pnpm i @payloadcms/db-sqlite
Payload installs directly in your Next.js /app folder, and you'll need to place some files into that folder for Payload to run. You can copy these files from the Blank Template on GitHub. Once you have the required Payload files in place in your /app folder, you should have something like this:
app/
├─ (payload)/
├── // Payload files
├─ (my-app)/
├── // Your app files
For an exact reference of the (payload) directory, see Project Structure.
The files that Payload needs to have in your /app folder do not regenerate, and will never change. Once you slot them in, you never have to revisit them. They are not meant to be edited and simply import Payload dependencies from @payloadcms/next for the REST / GraphQL API and Admin Panel.
You can name the (my-app) folder anything you want. The name does not matter and will just be used to clarify your directory structure for yourself. Common names might be (frontend), (app), or similar. More details.
Payload has a Next.js plugin that it uses to ensure compatibility with some of the packages Payload relies on, like mongodb or drizzle-kit.
To add the Payload Plugin, use withPayload in your next.config.js:
import { withPayload } from '@payloadcms/next/withPayload'
/** @type {import('next').NextConfig} */
const nextConfig = {
// Your Next.js config here
experimental: {
reactCompiler: false,
},
}
// Make sure you wrap your `nextConfig`
// with the `withPayload` plugin
export default withPayload(nextConfig) // highlight-lineTo import the Payload Plugin, you need to make sure your next.config file is set up to use ESM.
You can do this in one of two ways:
- Set your own project to use ESM, by adding
"type": "module"to yourpackage.jsonfile - Give your Next.js config the
.mjsfile extension
In either case, all requires and exports in your next.config file will need to be converted to import / export if they are not set up that way already.
Finally, you need to create a Payload Config. Generally the Payload Config is located at the root of your repository, or next to your /app folder, and is named payload.config.ts.
Here's what Payload needs at a bare minimum:
import sharp from 'sharp'
import { lexicalEditor } from '@payloadcms/richtext-lexical'
import { mongooseAdapter } from '@payloadcms/db-mongodb'
import { buildConfig } from 'payload'
export default buildConfig({
// If you'd like to use Rich Text, pass your editor here
editor: lexicalEditor(),
// Define and configure your collections in this array
collections: [],
// Your Payload secret - should be a complex and secure string, unguessable
secret: process.env.PAYLOAD_SECRET || '',
// Whichever Database Adapter you're using should go here
// Mongoose is shown as an example, but you can also use Postgres
db: mongooseAdapter({
url: process.env.DATABASE_URI || '',
}),
// If you want to resize images, crop, set focal point, etc.
// make sure to install it and pass it to the config.
// This is optional - if you don't need to do these things,
// you don't need it!
sharp,
})Although this is just the bare minimum config, there are many more options that you can control here. To reference the full config and all of its options, click here.
Once you have a Payload Config, update your tsconfig to include a path that points to it:
{
"compilerOptions": {
"paths": {
"@payload-config": ["./payload.config.ts"]
}
}
}After you've reached this point, it's time to boot up Payload. Start your project in your application's folder to get going. By default, the Next.js dev script is pnpm dev (or npm run dev if using npm).
After it starts, you can go to http://localhost:3000/admin to create your first Payload user!