🚀 Yapload - Enhanced Payload CMS Boilerplate

Yapload is a high-performance, aesthetically superior boilerplate built on top of Payload CMS. Designed for developers who demand excellence in both performance and user experience, Yapload takes the robust foundation of Payload CMS and elevates it with modern enhancements.

✨ Why Yapload?

Yapload isn't just another CMS template - it's a complete reimagining of what a modern content management system should be:

• 🎨 Superior Aesthetics: Beautiful, modern UI with diverse layout options
• ⚡ Blazing Performance: Optimized for speed with efficient data transfer and zero 504 errors
• 🎭 Interactive Experience: Enhanced editor with intuitive interactions
• 📊 Analytics Dashboard: Built-in analytics for content performance insights
• ✨ Custom Animations: Smooth, engaging animations throughout the interface
• 🔧 Developer Experience: Enhanced tooling and better code organization

🎯 Perfect for:

• Enterprise Websites: High-performance sites that scale
• Content Publishers: Advanced publication workflows with analytics
• Creative Portfolios: Stunning layouts with custom animations
• E-commerce Platforms: Fast, reliable online stores
• Multi-tenant Applications: Scalable SaaS platforms

🚀 Enhanced Features

Core Enhancements

• 🎨 Advanced Layout Builder - More layout options and customization
• 📊 Analytics Dashboard - Real-time content performance metrics
• ✨ Custom Animations - Smooth, engaging user interactions
• ⚡ Performance Optimizations - Lightning-fast load times
• 🎭 Interactive Editor - Enhanced content editing experience
• 🔒 Advanced Security - Enterprise-grade security features

Inherited from Payload CMS

• Pre-configured Payload Config
• Authentication
• Access Control
• Draft Preview
• Live Preview
• On-demand Revalidation
• SEO
• Search
• Redirects
• Jobs and Scheduled Publishing

🚀 Quick Start

Get Yapload up and running in minutes with these simple steps:

Prerequisites

• Node.js 18+ and pnpm
• Git
• A modern web browser

Installation

Method 1: Clone Yapload (Recommended)

git clone https://github.com/yourusername/Yapload.git my-Yapload-project
cd my-Yapload-project

Method 2: Use as Template

Click "Use this template" on the Yapload GitHub repository to create your own copy.

Development Setup

1. Environment Configuration

   cp .env.example .env

   Edit .env with your specific configuration values.

2. Install Dependencies

   pnpm install

3. Start Development Server

   pnpm dev

4. Access Your Application

   • Frontend: http://localhost:3000
   • Admin Panel: http://localhost:3000/admin
   • Analytics Dashboard: http://localhost:3000/admin/analytics

First Steps

1. Create your first admin user through the setup wizard
2. Explore the enhanced admin interface with custom animations
3. Try the advanced layout builder with new components
4. Check out the analytics dashboard for content insights
5. Experience the improved performance and interactive editor

🎨 Enhanced Features Overview

Advanced Layout Builder

Yapload extends the standard layout builder with:

• 20+ New Block Types: Advanced grids, carousels, testimonials, and more
• Responsive Design Tools: Visual breakpoint management
• Animation Controls: Per-block animation settings
• Custom CSS Support: Advanced styling options

Analytics Dashboard

Built-in analytics provide insights into:

• Content Performance: Page views, engagement metrics
• User Behavior: Navigation patterns, time on page
• SEO Metrics: Search rankings, keyword performance
• Real-time Data: Live visitor tracking

Performance Optimizations

• Image Optimization: Next-gen formats with lazy loading
• Code Splitting: Automatic bundle optimization
• CDN Integration: Global content delivery
• Caching Strategy: Intelligent cache management
• API Efficiency: Optimized queries and data fetching

Interactive Editor Experience

• Live Preview: Real-time content updates
• Drag & Drop: Intuitive content arrangement
• Keyboard Shortcuts: Power user productivity
• Auto-save: Never lose your work
• Collaborative Editing: Multi-user support

🛠️ Technology Stack

Yapload is built with modern, battle-tested technologies:

Core Framework

• Next.js 14+ - React framework with App Router
• Payload CMS 3.48.0 - Headless CMS foundation
• TypeScript - Type-safe development

Styling & UI

• Tailwind CSS - Utility-first CSS framework
• Framer Motion - Custom animations
• Radix UI - Accessible component primitives

Performance & Analytics

• Vercel Analytics - Performance monitoring
• Custom Analytics Engine - Content performance tracking
• Sharp - Image optimization

Development Tools

• ESLint - Code linting
• Prettier - Code formatting
• Playwright - End-to-end testing
• Vitest - Unit testing

Deployment & Infrastructure

• Docker - Containerization
• pnpm - Fast, efficient package manager
• Multiple deployment options - Vercel, Netlify, self-hosted

🔧 How Yapload Works

Yapload builds upon Payload CMS's solid foundation while adding powerful enhancements. The configuration is optimized for modern web applications with focus on performance, aesthetics, and user experience.

Collections

See the Collections docs for details on how to extend this functionality.

• Users (Authentication)

  Users are auth-enabled collections that have access to the admin panel and unpublished content. See Access Control for more details.

  For additional help, see the official Auth Example or the Authentication docs.

• Posts

  Posts are used to generate blog posts, news articles, or any other type of content that is published over time. All posts are layout builder enabled so you can generate unique layouts for each post using layout-building blocks, see Layout Builder for more details. Posts are also draft-enabled so you can preview them before publishing them to your website, see Draft Preview for more details.

• Pages

  All pages are layout builder enabled so you can generate unique layouts for each page using layout-building blocks, see Layout Builder for more details. Pages are also draft-enabled so you can preview them before publishing them to your website, see Draft Preview for more details.

• Media

  This is the uploads enabled collection used by pages, posts, and projects to contain media like images, videos, downloads, and other assets. It features pre-configured sizes, focal point and manual resizing to help you manage your pictures.

• Categories

  A taxonomy used to group posts together. Categories can be nested inside of one another, for example "News > Technology". See the official Payload Nested Docs Plugin for more details.

Globals

See the Globals docs for details on how to extend this functionality.

• Header

  The data required by the header on your front-end like nav links.

• Footer

  Same as above but for the footer of your site.

Access control

Basic access control is setup to limit access to various content based based on publishing status.

• users: Users can access the admin panel and create or edit content.
• posts: Everyone can access published posts, but only users can create, update, or delete them.
• pages: Everyone can access published pages, but only users can create, update, or delete them.

For more details on how to extend this functionality, see the Payload Access Control docs.

Layout Builder

Create unique page layouts for any type of content using a powerful layout builder. This template comes pre-configured with the following layout building blocks:

• Hero
• Content
• Media
• Call To Action
• Archive

Each block is fully designed and built into the front-end website that comes with this template. See Website for more details.

Lexical editor

A deep editorial experience that allows complete freedom to focus just on writing content without breaking out of the flow with support for Payload blocks, media, links and other features provided out of the box. See Lexical docs.

Draft Preview

All posts and pages are draft-enabled so you can preview them before publishing them to your website. To do this, these collections use Versions with drafts set to true. This means that when you create a new post, project, or page, it will be saved as a draft and will not be visible on your website until you publish it. This also means that you can preview your draft before publishing it to your website. To do this, we automatically format a custom URL which redirects to your front-end to securely fetch the draft version of your content.

Since the front-end of this template is statically generated, this also means that pages, posts, and projects will need to be regenerated as changes are made to published documents. To do this, we use an afterChange hook to regenerate the front-end when a document has changed and its _status is published.

For more details on how to extend this functionality, see the official Draft Preview Example.

Live preview

In addition to draft previews you can also enable live preview to view your end resulting page as you're editing content with full support for SSR rendering. See Live preview docs for more details.

On-demand Revalidation

We've added hooks to collections and globals so that all of your pages, posts, footer, or header changes will automatically be updated in the frontend via on-demand revalidation supported by Nextjs.

Note: if an image has been changed, for example it's been cropped, you will need to republish the page it's used on in order to be able to revalidate the Nextjs image cache.

SEO

This template comes pre-configured with the official Payload SEO Plugin for complete SEO control from the admin panel. All SEO data is fully integrated into the front-end website that comes with this template. See Website for more details.

Search

This template also pre-configured with the official Payload Search Plugin to showcase how SSR search features can easily be implemented into Next.js with Payload. See Website for more details.

Redirects

If you are migrating an existing site or moving content to a new URL, you can use the redirects collection to create a proper redirect from old URLs to new ones. This will ensure that proper request status codes are returned to search engines and that your users are not left with a broken link. This template comes pre-configured with the official Payload Redirects Plugin for complete redirect control from the admin panel. All redirects are fully integrated into the front-end website that comes with this template. See Website for more details.

Jobs and Scheduled Publish

We have configured Scheduled Publish which uses the jobs queue in order to publish or unpublish your content on a scheduled time. The tasks are run on a cron schedule and can also be run as a separate instance if needed.

Note: When deployed on Vercel, depending on the plan tier, you may be limited to daily cron only.

Website

This template includes a beautifully designed, production-ready front-end built with the Next.js App Router, served right alongside your Payload app in a instance. This makes it so that you can deploy both your backend and website where you need it.

Core features:

• Next.js App Router
• TypeScript
• React Hook Form
• Payload Admin Bar
• TailwindCSS styling
• shadcn/ui components
• User Accounts and Authentication
• Fully featured blog
• Publication workflow
• Dark mode
• Pre-made layout building blocks
• SEO
• Search
• Redirects
• Live preview

Cache

Although Next.js includes a robust set of caching strategies out of the box, Payload Cloud proxies and caches all files through Cloudflare using the Official Cloud Plugin. This means that Next.js caching is not needed and is disabled by default. If you are hosting your app outside of Payload Cloud, you can easily reenable the Next.js caching mechanisms by removing the no-store directive from all fetch requests in ./src/app/_api and then removing all instances of export const dynamic = 'force-dynamic' from pages files, such as ./src/app/(pages)/[slug]/page.tsx. For more details, see the official Next.js Caching Docs.

Development

To spin up this example locally, follow the Quick Start. Then Seed the database with a few pages, posts, and projects.

Working with Postgres

Postgres and other SQL-based databases follow a strict schema for managing your data. In comparison to our MongoDB adapter, this means that there's a few extra steps to working with Postgres.

Note that often times when making big schema changes you can run the risk of losing data if you're not manually migrating it.

Local development

Ideally we recommend running a local copy of your database so that schema updates are as fast as possible. By default the Postgres adapter has push: true for development environments. This will let you add, modify and remove fields and collections without needing to run any data migrations.

If your database is pointed to production you will want to set push: false otherwise you will risk losing data or having your migrations out of sync.

Migrations

Migrations are essentially SQL code versions that keeps track of your schema. When deploy with Postgres you will need to make sure you create and then run your migrations.

Locally create a migration

pnpm payload migrate:create

This creates the migration files you will need to push alongside with your new configuration.

On the server after building and before running pnpm start you will want to run your migrations

pnpm payload migrate

This command will check for any migrations that have not yet been run and try to run them and it will keep a record of migrations that have been run in the database.

Docker

Alternatively, you can use Docker to spin up this template locally. To do so, follow these steps:

1. Follow steps 1 and 2 from above, the docker-compose file will automatically use the .env file in your project root
2. Next run docker-compose up
3. Follow steps 4 and 5 from above to login and create your first admin user

That's it! The Docker instance will help you get up and running quickly while also standardizing the development environment across your teams.

Seed

To seed the database with a few pages, posts, and projects you can click the 'seed database' link from the admin panel.

The seed script will also create a demo user for demonstration purposes only:

• Demo Author
  • Email: demo-author@payloadcms.com
  • Password: password

NOTICE: seeding the database is destructive because it drops your current database to populate a fresh one from the seed template. Only run this command if you are starting a new project or can afford to lose your current data.

Production

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

1. Invoke the next build script by running pnpm build or npm run build in your project root. This creates a .next directory with a production-ready admin bundle.
2. Finally run pnpm start or npm run start to run Node in production and serve Payload from the .build directory.
3. When you're ready to go live, see Deployment below for more details.

Deploying to Payload Cloud

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.

Deploying to Vercel

This template can also be deployed to Vercel for free. You can get started by choosing the Vercel DB adapter during the setup of the template or by manually installing and configuring it:

pnpm add @payloadcms/db-vercel-postgres

// payload.config.ts
import { vercelPostgresAdapter } from '@payloadcms/db-vercel-postgres'

export default buildConfig({
  // ...
  db: vercelPostgresAdapter({
    pool: {
      connectionString: process.env.POSTGRES_URL || '',
    },
  }),
  // ...

We also support Vercel's blob storage:

pnpm add @payloadcms/storage-vercel-blob

// payload.config.ts
import { vercelBlobStorage } from '@payloadcms/storage-vercel-blob'

export default buildConfig({
  // ...
  plugins: [
    vercelBlobStorage({
      collections: {
        [Media.slug]: true,
      },
      token: process.env.BLOB_READ_WRITE_TOKEN || '',
    }),
  ],
  // ...

There is also a simplified one click deploy to Vercel should you need it.

Self-hosting

Before deploying your app, you need to:

1. Ensure your app builds and serves in production. See Production for more details.
2. You can then deploy Payload as you would any other Node.js or Next.js application either directly on a VPS, DigitalOcean's Apps Platform, via Coolify or more. More guides coming soon.

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.