Overview:
The Payload website is the official repository for Payload’s website. It is built using Payload itself and showcases features like utilizing Payload’s GraphQL API, implementing dynamic light/dark mode in a Next.js site without flickering, rendering docs from MDX to Next.js pages, integrating Stripe for custom SaaS solutions, and more. The tech stack includes TypeScript, Next.js 13 with App Router, SCSS Modules, GraphQL, MDX, and Stripe for Payload Cloud.
Features:
- Built with Payload: Leverages Payload for all functionalities except documentation stored as Markdown.
- Tech Stack: TypeScript, Next.js 13, SCSS Modules, GraphQL, MDX, and Stripe for Payload Cloud.
- Open-source CMS: The site’s CMS is open-source and serves as a learning example for building Payload projects at scale.
- Payload Cloud Integration: Offers one-click deployment of production-ready instances from GitHub repos.
- Local Setup Guide: Includes instructions for cloning, setting up environment variables, and running the project locally.
- Documentation Handling: Docs are stored in the Payload repo as Markdown and fetched at build time for rendering.
- License: Available under the MIT license.
Installation:
To run the project locally:
- Clone the repository.
- Run
yarn
. - Create an
.env
file by copying.env.example
and fill in the required values. - Run
yarn dev
. - Update the hosts file with
local.payloadcms.com:3000
to handle http-only cookie policies and GitHub App redirection.
Summary:
The Payload website showcases the capabilities of Payload by using its features like GraphQL API, Stripe integration, and dynamic theming. It serves as a valuable resource for learning how to build projects at scale using Payload. The open-source nature of the CMS and the availability of one-click deployment through Payload Cloud make it an efficient tool for developers looking to streamline their development process.