payload/examples/nested-docs/payload

Payload Nested Docs Example

This example demonstrates how to achieve nested docs in Payload using the official Nested Docs Plugin.

There are various fully working front-ends made explicitly for this example, including:

• Next.js App Router
• Next.js Pages Router

Follow the instructions in each respective README to get started. If you are setting up nested docs for another front-end, please consider contributing to this repo with your own example!

Quick Start

To spin up this example locally, follow these steps:

1. Clone this repo
2. cd into this directory and run yarn or npm install
3. cp .env.example .env to copy the example environment variables
4. yarn dev or npm run dev to start the server and seed the database
5. open http://localhost:3000/admin to access the admin panel
6. Login with email demo@payloadcms.com and password demo

How it works

The Nested Docs Plugin automatically adds a parent field onto each enabled collection. Each parent is a reference to another document of the same collection and is used to create the document hierarchy.

The plugin also adds a breadcrumbs field to each document, which is an array of references to each parent document in the tree. This field is automatically populated by the plugin, and can used to generate the full titles, URLs, etc.

See the official Nested Docs Plugin for full details.

Development

To spin up this example locally, follow the Quick Start.

Seed

On boot, a seed script is included to create a user and the following pages:

• Home
  • Slug: home
  • URL: /
• Parent
  • Slug: parent
  • URL: /parent
• Child
  • Slug: child
  • URL: /parent/child
• Grandchild
  • Slug: grandchild
  • URL: /parent/child/grandchild

Production

To run Payload in production, you need to build and serve the Admin panel. To do so, follow these steps:

1. First invoke the payload build script by running yarn build or npm run build in your project root. This creates a ./build directory with a production-ready admin bundle.
2. Then run yarn serve or npm run serve to run Node in production and serve Payload from the ./build directory.

Deployment

The easiest way to deploy your project is to use Payload Cloud, a one-click hosting solution to deploy production-ready instances of your Payload apps directly from your GitHub repo. You can also deploy your app manually, check out the deployment documentation for full details.

Questions

If you have any issues or questions, reach out to us on Discord or start a GitHub discussion.