6873b139e2
Removes examples that are now duplicative or unnecessary due to new features in 3.0: ### Custom server This one can be removed in favor of [Next.js documentation](https://nextjs.org/docs/pages/building-your-application/configuring/custom-server) ### Hierarchy The new `join` field can solve for many of the use cases for the `hierarchy` example. Bi-directional relationships with the `join` field should be preferred here. ### Nested Docs, Redirects Our website template showcases how to use the `nested-docs` and `redirects` plugins in-depth, with real-world examples. ### Virtual Fields Virtual fields have gotten significantly easier and can now be defined by specifying `virtual: true`. Not a big need for a full example any longer. --------- Co-authored-by: Jacob Fletcher <jacobsfletch@gmail.com>
37 lines
2.3 KiB
Plaintext
37 lines
2.3 KiB
Plaintext
---
|
|
title: Examples
|
|
label: Overview
|
|
order: 10
|
|
desc:
|
|
keywords: example, examples, starter, boilerplate, template, templates
|
|
---
|
|
|
|
Payload provides a vast array of examples to help you get started with your project no matter what you are working on. These examples are designed to be easy to get up and running, and to be easy to understand. They showcase nothing more than the specific features being demonstrated so you can easily decipher what is going on.
|
|
|
|
Examples are changing every day, so be sure to check back often to see what new examples have been added. If you have a specific example you would like to see, please feel free to start a new [Discussion](https://github.com/payloadcms/payload/discussions) or open a new [PR](https://github.com/payloadcms/payload/pulls) to add it yourself.
|
|
|
|
- [Auth](https://github.com/payloadcms/payload/tree/main/examples/auth)
|
|
- [Custom Components](https://github.com/payloadcms/payload/tree/main/examples/custom-components)
|
|
- [Draft Preview](https://github.com/payloadcms/payload/tree/main/examples/draft-preview)
|
|
- [Email](https://github.com/payloadcms/payload/tree/main/examples/email)
|
|
- [Form Builder](https://github.com/payloadcms/payload/tree/main/examples/form-builder)
|
|
- [Live Preview](https://github.com/payloadcms/payload/tree/main/examples/live-preview)
|
|
- [Multi-tenant](https://github.com/payloadcms/payload/tree/main/examples/multi-tenant)
|
|
- [Tailwind / Shadcn-ui](https://github.com/payloadcms/payload/tree/main/examples/tailwind-shadcn-ui)
|
|
- [Tests](https://github.com/payloadcms/payload/tree/main/examples/testing)
|
|
- [White-label Admin UI](https://github.com/payloadcms/payload/tree/main/examples/whitelabel)
|
|
|
|
When necessary, some examples include a front-end. Examples that require a front-end share this folder structure:
|
|
|
|
```plaintext
|
|
example/
|
|
├── payload/
|
|
├── next-app/
|
|
├── next-pages/
|
|
├── react-router/
|
|
├── vue/
|
|
├── svelte/
|
|
```
|
|
|
|
Where `payload` is your Payload project, and the other directories are dedicated to their respective front-end framework. We are adding new examples every day, so if your framework of choice is not yet supported in any particular example, please feel free to start a new [Discussion](https://github.com/payloadcms/payload/discussions) or open a new [PR](https://github.com/payloadcms/payload/pulls) to add it yourself.
|