payload

Payload

A self-hosted, JavaScript headless CMS & application framework built with Express, MongoDB and React.

Quick Start

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.

Features

• GraphQL, REST, and Local APIs
• Easily customizable ReactJS Admin
• Fully self-hosted
• Extensible Authentication
• Local file storage & upload
• Field-based Localization
• Block-based Layout Builder
• Extensible SlateJS rich text editor
• Array field type
• Field conditional logic
• Extremely granular Access Control
• Document and field-level hooks for every action Payload provides
• Built with Typescript & very Typescript-friendly
• Intensely fast API
• Highly secure thanks to HTTP-only cookies, CSRF protection, and more

Code-first

If you know JavaScript, you know Payload. Payload is 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 wrote 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.

Free for development use

Payload is 100% free for use on local environments such as localhost and staging sites such as staging.mycoolsite.com. When it's time to go to production, Payload charges a low and flat fee that doesn't change whatsoever based on your usage.

Installation

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 write out your own app from scratch.

License

Find the Payload license here.

Changelog

0.1.144 (2021-01-16)

Bug Fixes

• add default user to collections before checking for valid relationships (b2d05c7)
• handle user collection 'auth: true' (c303711)