67 lines
3.6 KiB
Markdown
67 lines
3.6 KiB
Markdown
<p align="center"><a href="https://github.com/nastyox/Rando.js#nastyox"></a></p>
|
|
<h1 align="center">Payload</h1>
|
|
<p align="center">A self-hosted, JavaScript headless CMS & application framework built with Express, MongoDB and React.</p>
|
|
|
|
<a href="https://payloadcms.com">
|
|
<img src="https://payloadcms.com/images/admin.jpg" alt="Payload headless CMS Admin panel built with React" />
|
|
</a>
|
|
|
|
### Quick Start
|
|
|
|
```
|
|
npx create-payload-app
|
|
```
|
|
|
|
Alternatively, it only takes about five minutes to [write out your own app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).
|
|
|
|
### 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.
|
|
|
|
### Features
|
|
|
|
- [GraphQL](https://payloadcms.com/docs/graphql/overview), [REST](https://payloadcms.com/docs/rest-api/overview), and [Local](https://payloadcms.com/docs/local-api/overview) APIs
|
|
- [Easily customizable ReactJS Admin](https://payloadcms.com/docs/admin/overview)
|
|
- [Fully self-hosted](https://payloadcms.com/docs/production/deployment)
|
|
- [Extensible Authentication](https://payloadcms.com/docs/authentication/overview)
|
|
- [Local file storage & upload](https://payloadcms.com/docs/upload/overview)
|
|
- [Field-based Localization](https://payloadcms.com/docs/configuration/localization)
|
|
- [Block-based Layout Builder](https://payloadcms.com/docs/fields/blocks)
|
|
- [Extensible SlateJS rich text editor](https://payloadcms.com/docs/fields/rich-text)
|
|
- [Array field type](https://payloadcms.com/docs/fields/array)
|
|
- [Field conditional logic](https://payloadcms.com/docs/fields/overview#conditional-logic)
|
|
- Extremely granular [Access Control](https://payloadcms.com/docs/access-control/overview)
|
|
- [Document and field-level hooks](https://payloadcms.com/docs/hooks/overview) 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](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:
|
|
|
|
```
|
|
npx create-payload-app
|
|
```
|
|
|
|
Alternatively, it only takes about five minutes to [write out your own app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).
|
|
|
|
## License
|
|
|
|
Find the Payload license [here](https://github.com/payloadcms/payload/blob/master/license.md).
|