Payload Multi-tenant

Contents

This repository has been setup with basic blocks, collections, fields, and globals. Additional some Payload plugins have been installed.

Blocks

• Accordion
• CTA
• Form
• Text with Media

Collections

• Pages
• Media
• Users

Fields

• Slug
• Hero
• Link
• Link Group
• Rich Text

Globals

• Footer
• Header
• Settings

Plugins

• Form Builder
• SEO

Getting Started

To use this repository, create a new repository and use this as a template. For documentation on how to do this see here.

Development

Once this repository has been used as a template for another repository, you'll be able to start developing the website. To do this, you'll first need to create a docker container for the mongoDB database.

Setup required services

• MongoDB
• Mailpit

To setup the required services as containers, you'll need to run the following command

docker compose up -d

Ensure that you've updated your .env file to point to the correct db connection string.

Mailpit

Mailpit is a local SMTP server to aid in development. It is configured to receive all emails sent to "127.0.0.1:1025" via SMTP.

You can access the Mailpit interface at http://localhost:8025 - this page will populate with any emails received by Mailpit.

The default configuration in env.example should be enough to ensure that this works without modification.

Emails

Email sending is enabled in Payload if either SMTP or SendGrid are configured in the environment variables. The default configuration from env.example will enable receiving emails via Mailpit.

Ladle

This repo comes installed with Ladle for component testing. Any new components that are added should also have relevant stories created for them.

To run Ladle using the following command:

pnpm ladle serve

For more information about Ladle see the docs

Install proto

Note: if you do not have proto installed on your machine follow this guide first: Proto install guide

In your terminal run the following command to install the relevant node and pnpm version for this project.

proto install

Run payload

Once the db container is setup you'll need to install the node modules. Run the following command to install all required node modules.

pnpm i

Once the installation is complete you can start the server by running the following command.

pnpm dev

You should now be able to hit either of the below urls and start local development.

Front end

Admin