Skip to content

Latest commit

 

History

History
139 lines (103 loc) · 7.14 KB

README.md

File metadata and controls

139 lines (103 loc) · 7.14 KB

Payload Logo

The most powerful TypeScript CMS

Code-first Headless CMS that bridges the gap between CMS and application framework


  GitHub Workflow Status   git commit activity   Discord   npm   Payload Twitter


Payload headless CMS Admin panel built with React

⭐ Why Payload?

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:

  • 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.
  • Bring your own Express server and do whatever you need on top of Payload. Payload doesn't impose anything on you or your app.
  • Completely control the Admin panel by using your own React components. Swap out fields or even entire views with ease.
  • Use your data however and wherever you need thanks to auto-generated, yet fully extensible REST, GraphQL, and Local Node APIs.

Read more on our website

✨ Features

Request Feature

🚀 Quick Start

Before beginning to work with Payload, make sure you have all of the required software.

From there, the easiest way to get started with Payload is to use the create-payload-app package:

npx create-payload-app

Alternatively, it only takes about five minutes to create an app from scratch.

🗒️ Documentation

Check out the Payload website to find in-depth documentation for everything that Payload offers.

🙋 Contributing

If you want to add contributions to this repository, please follow the instructions in contributing.md.

📚 Examples and Templates

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.

🔌 Plugins

Payload is highly extensible and allows you to install or distribute plugins that add or remove functionality. There are both officially-supported and community-supported plugins available. If you maintain your own plugin, consider adding the payload-plugin topic to your GitHub repository for others to find.

🚨 Need help?

There are lots of good conversations and resources in our Github Discussions board and our Discord Server. If you're struggling with something, chances are, someone's already solved what you're up against. 👇

⭐ Like what we're doing? Give us a star

payload-github-star

👏 Thanks to all our contributors