Blame: README.md - payloadcms/payload

payloadcms / payload UNCLAIMED

Payload is the open-source, fullstack Next.js framework, giving you instant backend superpowers. Get a full TypeScript backend and admin panel instantly. Use Payload as a headless CMS or for building powerful applications.

0 0 510 TypeScript

Normal View History Raw

chore: README logo (#1732) * chore: README header logo * updates conditionally rendered logo for light/dark mode * adds img folder with light and dark logos to utilize gh conditional * moves payload logos to avoid polluting root directory Co-authored-by: Sean Zubrickas <zubricks@gmail.com> 2022-12-20 13:24:07 -05:00			`<h1 align="center">`
			`<img width="350" src="/src/admin/assets/images/payload-logo-dark.svg#gh-light-mode-only" alt="payload cms">`
			`<img width="350" src="/src/admin/assets/images/payload-logo-light.svg#gh-dark-mode-only" alt="payload cms">`
			`</h1>`
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00
			`<h2 align="center" style="padding-bottom: 24px !important;">The most powerful TypeScript CMS</h2>`
			`<p align="center">Code-first Headless CMS that bridges the gap between CMS and application framework</p>`

			`<h3 align="center">`
			`<br />`
			`<a href="https://payloadcms.com/docs/getting-started/what-is-payload" rel="dofollow"><strong>Explore the docs »</strong></a>`
			`<br />`
			`<br/>`
			`</h3>`

			`<h4 align="center">`
			`<a target="_blank" href="https://github.com/payloadcms/payload/discussions">Request Feature</a>`
			`·`
			`<a target="_blank" href="https://github.com/payloadcms/payload/issues/new?assignees=&labels=possible-bug&template=BUG_REPORT.md">Report Bug</a>`
			`·`
			`<a target="_blank" href="https://discord.com/invite/r6sCXqVk3v">Join Discord</a>`
			`·`
			`<a target="_blank" rel="dofollow" href="https://payloadcms.com/docs/getting-started/what-is-payload">Docs</a>`
			`·`
			`<a target="_blank" rel="dofollow" href="https://payloadcms.com/">Website</a>`
			`</h4>`

			`<br />`

chore: add badges to readme and rename workflow 2021-01-05 22:22:52 -05:00			`<p align="center">`
chore: add MIT license badge 2022-07-20 15:05:47 -07:00			`<a href="https://opensource.org/licenses/MIT">`
			`<img src="https://img.shields.io/badge/License-MIT-blue.svg" />`
			`</a>`
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			` `
chore: add badges to readme and rename workflow 2021-01-05 22:22:52 -05:00			`<a href="https://github.com/payloadcms/payload/actions">`
chore: update discord invite link 2022-04-24 10:24:37 -04:00			`<img src="https://github.com/payloadcms/payload/workflows/build/badge.svg" />`
chore: add badges to readme and rename workflow 2021-01-05 22:22:52 -05:00			`</a>`
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			` `
			`<a href="https://github.com/payloadcms/payload/commits">`
			`<img src="https://img.shields.io/github/commit-activity/m/payloadcms/payload" alt="git commit activity"/>`
chore: add tweet link to readme 2021-01-07 22:59:25 -05:00			`</a>`
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			` `
chore: update discord invite link 2022-04-24 10:24:37 -04:00			`<a href="https://discord.com/invite/r6sCXqVk3v">`
chore: change discord readme badge to blurple 2022-11-04 10:31:42 -04:00			`<img alt="Discord" src="https://img.shields.io/discord/967097582721572934?label=Discord&color=7289da" />`
chore: add public discord link (#541) 2022-04-22 14:35:39 -04:00			`</a>`
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			` `
			`<a href="https://www.npmjs.com/package/payload">`
			`<img alt="npm" src="https://img.shields.io/npm/v/payload" />`
			`</a>`
			` `
			`<a href="https://twitter.com/payloadcms">`
			`<img src="https://img.shields.io/twitter/follow/payloadcms?label=Follow" alt="Payload CMS Twitter" />`
			`</a>`
chore: add badges to readme and rename workflow 2021-01-05 22:22:52 -05:00			`</p>`
Add basic README 2018-04-21 00:35:21 -06:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`<br />`

chore: update readme 2021-01-05 13:09:30 -05:00			`<a href="https://payloadcms.com">`
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`<img src="https://cms.payloadcms.com/media/payload-github-header.jpg" alt="Payload headless CMS Admin panel built with React" />`
chore: update readme 2021-01-05 13:09:30 -05:00			`</a>`
Update README 2020-08-14 13:50:21 -04:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`<br />`

			`## ⭐ 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.`

			`## ✨ Features`
docs: readme 2021-01-05 12:38:20 -05:00
Free and open-source under MIT license (#565) * feat: free and open-source under MIT license 2022-05-16 19:25:20 -04:00			`- Completely free and open-source`
docs: readme 2021-01-05 12:38:20 -05:00			`- [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)`
Free and open-source under MIT license (#565) * feat: free and open-source under MIT license 2022-05-16 19:25:20 -04:00			`- [Version History and Drafts](https://payloadcms.com/docs/versions/overview)`
docs: readme 2021-01-05 12:38:20 -05:00			`- [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`

chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`## 🚀 Quick Start`
Add basic README 2018-04-21 00:35:21 -06:00
docs: readme 2021-01-05 12:38:20 -05:00			`Before beginning to work with Payload, make sure you have all of the [required software](https://payloadcms.com/docs/getting-started/installation).`
Add basic README 2018-04-21 00:35:21 -06:00
docs: readme 2021-01-05 12:38:20 -05:00			From there, the easiest way to get started with Payload is to use the `create-payload-app` package:
Update README 2020-08-14 13:50:21 -04:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			```text
docs: readme 2021-01-05 12:38:20 -05:00			`npx create-payload-app`
			```
Update README 2020-08-14 13:50:21 -04:00
Free and open-source under MIT license (#565) * feat: free and open-source under MIT license 2022-05-16 19:25:20 -04:00			`Alternatively, it only takes about five minutes to [create an app from scratch](https://payloadcms.com/docs/getting-started/installation#from-scratch).`

chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`## 🗒️ Documentation`
Free and open-source under MIT license (#565) * feat: free and open-source under MIT license 2022-05-16 19:25:20 -04:00
			`Check out the [Payload website](https://payloadcms.com/docs/getting-started/what-is-payload) to find in-depth documentation for everything that Payload offers.`
chore: change discord readme badge to blurple 2022-11-04 10:31:42 -04:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`## 🙋 Contributing`
doc: Adding a contributing section to README.md (#804) 2022-07-26 06:58:11 -07:00
			`If you want to add contributions to this repository, please follow the instructions in [contributing.md](./contributing.md).`
Free and open-source under MIT license (#565) * feat: free and open-source under MIT license 2022-05-16 19:25:20 -04:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`## 🚨 Need help?`

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

			`- [GitHub Discussions](https://github.com/payloadcms/payload/discussions)`
			`- [GitHub Issues](https://github.com/payloadcms/payload/issues)`
			`- [Discord](https://t.co/30APlsQUPB)`
Free and open-source under MIT license (#565) * feat: free and open-source under MIT license 2022-05-16 19:25:20 -04:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`## ⭐ Like what we're doing? Give us a star`
Free and open-source under MIT license (#565) * feat: free and open-source under MIT license 2022-05-16 19:25:20 -04:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`![payload-github-star](https://cms.payloadcms.com/media/payload-github-star.gif)`
Update README 2020-08-14 13:50:21 -04:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`## 👏 Thanks to all our contributors`
Add basic README 2018-04-21 00:35:21 -06:00
chore: readme updates (#1717) * refines readme banner image, badges and headings * chore: spruce up README a bit more * adds dark/light mode support for logo Co-authored-by: Elliot DeNolf <denolfe@gmail.com> 2022-12-20 09:28:12 -05:00			`<img align="left" src="https://contributors-img.web.app/image?repo=payloadcms/payload"/>`