6b4842d44d
Adds the ability to create a project using an existing in the Payload repo example through `create-payload-app`: For example: `pnpx create-payload-app --example custom-server` - creates a project from the [custom-server](https://github.com/payloadcms/payload/tree/main/examples/custom-server) example. This is much easier and faster then downloading the whole repo and copying the example to another folder. Note that we don't configure the payload config with the storage / DB adapter there because examples can be very specific.
29 lines
1.7 KiB
Plaintext
29 lines
1.7 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 precisely what is going on.
|
|
|
|
- [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)
|
|
|
|
If you'd like to run the examples, you can use `create-payload-app` to create a project from one:
|
|
|
|
```sh
|
|
npx create-payload-app --example example_name
|
|
```
|
|
|
|
We are adding new examples every day, so if your particular use case is not demonstrated in any existing 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.
|