removes yarn lock from virtual fields example because of merge conflict
97
README.md
@@ -1,37 +1,13 @@
|
|||||||
<p style="border: none; margin-bottom:0; padding-bottom: 0;" align="center">
|
<a href="https://payloadcms.com">
|
||||||
<a href="https://payloadcms.com">
|
<img width="100%" src="src/admin/assets/images/github-banner-alt.jpg" alt="Payload headless CMS Admin panel built with React" />
|
||||||
<picture>
|
</a>
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/payloadcms/payload/master/src/admin/assets/images/payload-logo-light.svg">
|
|
||||||
<img width="350" alt="Payload Logo" src="https://raw.githubusercontent.com/payloadcms/payload/master/src/admin/assets/images/payload-logo-dark.svg">
|
|
||||||
</picture>
|
|
||||||
</a>
|
|
||||||
</p>
|
|
||||||
|
|
||||||
<h3 align="center">The most powerful TypeScript CMS</h3>
|
|
||||||
<p align="center">Code-first Headless CMS that bridges the gap between CMS and application framework</p>
|
|
||||||
|
|
||||||
<h3 align="center">
|
|
||||||
<a target="_blank" href="https://payloadcms.com/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the docs</strong></a>
|
|
||||||
·
|
|
||||||
<a target="_blank" href="https://demo.payloadcms.com/" rel="dofollow"><strong>Try Live Demo</strong></a>
|
|
||||||
<br />
|
|
||||||
</h3>
|
|
||||||
|
|
||||||
<br />
|
<br />
|
||||||
|
<br />
|
||||||
<p align="center">
|
<p align="left">
|
||||||
<a href="https://opensource.org/licenses/MIT">
|
|
||||||
<img src="https://img.shields.io/badge/License-MIT-blue.svg?style=flat-square" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://github.com/payloadcms/payload/actions">
|
<a href="https://github.com/payloadcms/payload/actions">
|
||||||
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/payloadcms/payload/tests.yml?style=flat-square">
|
<img alt="GitHub Workflow Status" src="https://img.shields.io/github/actions/workflow/status/payloadcms/payload/tests.yml?style=flat-square">
|
||||||
</a>
|
</a>
|
||||||
|
|
||||||
<a href="https://github.com/payloadcms/payload/commits">
|
|
||||||
<img src="https://img.shields.io/github/commit-activity/m/payloadcms/payload?style=flat-square" alt="git commit activity"/>
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<a href="https://discord.gg/payload">
|
<a href="https://discord.gg/payload">
|
||||||
<img alt="Discord" src="https://img.shields.io/discord/967097582721572934?label=Discord&color=7289da&style=flat-square" />
|
<img alt="Discord" src="https://img.shields.io/discord/967097582721572934?label=Discord&color=7289da&style=flat-square" />
|
||||||
</a>
|
</a>
|
||||||
@@ -44,25 +20,44 @@
|
|||||||
<img src="https://img.shields.io/badge/follow-payloadcms-1DA1F2?logo=twitter&style=flat-square" alt="Payload Twitter" />
|
<img src="https://img.shields.io/badge/follow-payloadcms-1DA1F2?logo=twitter&style=flat-square" alt="Payload Twitter" />
|
||||||
</a>
|
</a>
|
||||||
</p>
|
</p>
|
||||||
|
<hr/>
|
||||||
|
<h4>
|
||||||
|
<a target="_blank" href="https://payloadcms.com/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the Docs</strong></a> · <a target="_blank" href="https://payloadcms.com/community-help" rel="dofollow"><strong>Community Help</strong></a> · <a target="_blank" href="https://demo.payloadcms.com/" rel="dofollow"><strong>Try Live Demo</strong></a> · <a target="_blank" href="https://github.com/payloadcms/payload/discussions/1539" rel="dofollow"><strong>Roadmap</strong></a> · <a target="_blank" href="https://www.g2.com/products/payload-cms/reviews#reviews" rel="dofollow"><strong>View G2 Reviews</strong></a>
|
||||||
|
</h4>
|
||||||
|
<hr/>
|
||||||
|
<h3>Benefits over a regular CMS</h3>
|
||||||
|
<ul>
|
||||||
|
<li>Don’t hit some third-party SaaS API, hit your own API</li>
|
||||||
|
<li>Use your own database and own your data</li>
|
||||||
|
<li>It's just Express - do what you want outside of Payload</li>
|
||||||
|
<li>No need to learn how Payload works - if you know JS, you know Payload</li>
|
||||||
|
<li>No vendor lock-in</li>
|
||||||
|
<li>Avoid microservices hell - get everything (even auth) in one place</li>
|
||||||
|
<li>Never touch ancient WP code again</li>
|
||||||
|
<li>Build faster, never hit a roadblock</li>
|
||||||
|
<li>Both admin and backend are 100% extensible</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
<br />
|
## ☁️ Deploy instantly with Payload Cloud.
|
||||||
|
Create a cloud account, connect your GitHub, and [deploy in minutes](https://payloadcms.com/new).
|
||||||
|
|
||||||
<a href="https://payloadcms.com">
|
## 🚀 Get started by self-hosting completely free, forever.
|
||||||
<img src="https://cms.payloadcms.com/media/payload-github-header.jpg" alt="Payload headless CMS Admin panel built with React" />
|
|
||||||
</a>
|
|
||||||
|
|
||||||
<br />
|
Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation).
|
||||||
|
|
||||||
## ⭐ Why Payload?
|
```text
|
||||||
|
npx create-payload-app
|
||||||
|
```
|
||||||
|
|
||||||
Payload is a CMS that has been designed for developers from the ground up to deliver them what they need to build great digital products. If you know JavaScript, you know Payload. It's a _code-first_ CMS, which allows us to do a lot of things right:
|
Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).
|
||||||
|
|
||||||
- Payload gives you everything you need, but then steps back and lets you build what you want in JavaScript or TypeScript - with no unnecessary complexity brought by GUIs. You'll understand how your CMS works because you will have written it exactly how you want it.
|
## 🖱️ One-click templates
|
||||||
- Bring your own Express server and do whatever you need on top of Payload. Payload doesn't impose anything on you or your app.
|
### 🛒 [E-Commerce](https://github.com/payloadcms/payload/tree/master/templates/ecommerce)
|
||||||
- Completely control the Admin panel by using your own React components. Swap out fields or even entire views with ease.
|
Eliminate the need to combine Shopify and a CMS, and instead do it all with Payload + Stripe. Best of all, you can extend it as much as you need.
|
||||||
- Use your data however and wherever you need thanks to auto-generated, yet fully extensible REST, GraphQL, and Local Node APIs.
|
|
||||||
|
|
||||||
<a target="_blank" href="https://payloadcms.com/" rel="dofollow"><strong>Read more on our website</strong></a>
|
[All Official Templates](https://github.com/orgs/payloadcms/repositories?q=topic%3Apayload-template) · [Community Templates](https://github.com/topics/payload-template)
|
||||||
|
|
||||||
|
**If you maintain your own template, consider adding the `payload-template` topic to your GitHub repository for others to find.**
|
||||||
|
|
||||||
## ✨ Features
|
## ✨ Features
|
||||||
|
|
||||||
@@ -86,18 +81,6 @@ Payload is a CMS that has been designed for developers from the ground up to del
|
|||||||
|
|
||||||
<a target="_blank" href="https://github.com/payloadcms/payload/discussions"><strong>Request Feature</strong></a>
|
<a target="_blank" href="https://github.com/payloadcms/payload/discussions"><strong>Request Feature</strong></a>
|
||||||
|
|
||||||
## 🚀 Quick Start
|
|
||||||
|
|
||||||
Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation).
|
|
||||||
|
|
||||||
From there, the easiest way to get started with Payload is to use the `create-payload-app` package:
|
|
||||||
|
|
||||||
```text
|
|
||||||
npx create-payload-app
|
|
||||||
```
|
|
||||||
|
|
||||||
Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).
|
|
||||||
|
|
||||||
## 🗒️ Documentation
|
## 🗒️ Documentation
|
||||||
|
|
||||||
Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.
|
Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.
|
||||||
@@ -106,13 +89,11 @@ Check out the [Payload website](https://payloadcms.com/docs/getting-started/what
|
|||||||
|
|
||||||
If you want to add contributions to this repository, please follow the instructions in [contributing.md](./contributing.md).
|
If you want to add contributions to this repository, please follow the instructions in [contributing.md](./contributing.md).
|
||||||
|
|
||||||
## 📚 Examples and Templates
|
## 📚 Examples
|
||||||
|
|
||||||
The examples directory is a great resource for learning how to setup Payload in a variety of different ways. There are also a number of templates to help get you going very quickly. If you maintain your own template, consider adding the `payload-template` topic to your GitHub repository for others to find.
|
The examples directory is a great resource for learning how to setup Payload in a variety of different ways.
|
||||||
|
|
||||||
- [Examples Directory](./examples)
|
[Examples Directory](./examples)
|
||||||
- [Official Templates](https://github.com/orgs/payloadcms/repositories?q=topic%3Apayload-template)
|
|
||||||
- [Community Templates](https://github.com/topics/payload-template)
|
|
||||||
|
|
||||||
## 🔌 Plugins
|
## 🔌 Plugins
|
||||||
|
|
||||||
|
|||||||
BIN
src/admin/assets/images/benefits-banner.jpg
Normal file
|
After Width: | Height: | Size: 160 KiB |
BIN
src/admin/assets/images/cloud-cta-inline.jpg
Normal file
|
After Width: | Height: | Size: 165 KiB |
BIN
src/admin/assets/images/github-banner-alt.jpg
Normal file
|
After Width: | Height: | Size: 261 KiB |
BIN
src/admin/assets/images/github-banner.jpg
Normal file
|
After Width: | Height: | Size: 226 KiB |
|
Before Width: | Height: | Size: 8.9 KiB After Width: | Height: | Size: 8.7 KiB |
|
Before Width: | Height: | Size: 8.9 KiB After Width: | Height: | Size: 8.7 KiB |