Tool Mặt bằng
A Payload-based floor-plan management tool that helps teams organize layout content and publish updates with a cleaner editorial workflow.
This is the official Payload Website Template. Use it to power websites, blogs, or portfolios from small to enterprise. This repo includes a fully-working backend, enterprise-grade admin panel, and a beautifully designed, production-ready website.
Payload Website Template
This is the official Payload Website Template. Use it to power websites, blogs, or portfolios from small to enterprise. This repo includes a fully-working backend, enterprise-grade admin panel, and a beautifully designed, production-ready website.
This template is right for you if you are working on:
- A personal or enterprise-grade website, blog, or portfolio - A content publishing platform with a fully featured publication workflow - Exploring the capabilities of Payload
Core features:
- Pre-configured Payload Config - Authentication - Access Control - Layout Builder - Draft Preview - Live Preview - On-demand Revalidation - SEO - Search - Redirects - Jobs and Scheduled Publishing - Website
Quick Start
To spin up this example locally, follow these steps:
Clone
If you have not done so already, you need to have standalone copy of this repo on your machine. If you've already cloned this repo, skip to Development.
Method 1 (recommended)
Go to Payload Cloud and clone this template. This will create a new repository on your GitHub account with this template's code which you can then clone to your own machine.
Method 2
Use the create-payload-app CLI to clone this template directly to your machine:
Method 3
Use the git CLI to clone this template directly to your machine:
Development
1. First clone the repo if you have not done so already 1. cd my-project && cp .env.example .env to copy the example environment variables 1. pnpm install && pnpm dev to install dependencies and start the dev server 1. open http://localhost:3000 to open the app in your browser
That's it! Changes made in ./src will be reflected in your app. Follow the on-screen instructions to login and create your first admin user. Then check out Production once you're ready to build and serve your app, and Deployment when you're ready to go live.
How it works
The Payload config is tailored specifically to the needs of most websites. It is pre-configured in the following ways:
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 c