takumade/payload-cms-template

Payload CMS E commerce template

Payload E-Commerce Template

Development

To spin up this example locally, follow the Quick Start. Then Connect Stripe to enable payments, and Seed the database with a few products and pages.

Docker

Alternatively, you can use Docker to spin up this template locally. To do so, follow these steps:

1. Follow steps 1 and 2 from above, the docker-compose file will automatically use the .env file in your project root
2. Next run docker-compose up
3. Follow steps 4 and 5 from above to login and create your first admin user

That's it! The Docker instance will help you get up and running quickly while also standardizing the development environment across your teams.

Seed

To seed the database with a few products and pages you can run yarn seed. This template also comes with a GET /api/seed endpoint you can use to seed the database from the admin panel.

NOTICE: seeding the database is destructive because it drops your current database to populate a fresh one from the seed template. Only run this command if you are starting a new project or can afford to lose your current data.

Conflicting routes

In a monorepo when routes are bootstrapped to the same host, they can conflict with Payload's own routes if they have the same name. In our template we've named the Nextjs API routes to next to avoid this conflict.

This can happen with any other routes conflicting with Payload such as admin and we recommend using different names for custom routes. Alternatively you can also rename Payload's own routes via the configuration.

Production

To run Payload in production, you need to build and serve the Admin panel. To do so, follow these steps:

1. Invoke the payload build script by running yarn build or npm run build in your project root. This creates a ./build directory with a production-ready admin bundle.
2. Finally run yarn serve or npm run serve to run Node in production and serve Payload from the ./build directory.
3. When you're ready to go live, see Deployment for more details.

Deployment

Before deploying your app, you need to:

1. Switch your Stripe account to live mode and update your Stripe API keys. See Connect Stripe for more details.
2. Ensure your app builds and serves in production. See Production for more details.

The easiest way to deploy your project is to use Payload Cloud, a one-click hosting solution to deploy production-ready instances of your Payload apps directly from your GitHub repo. You can also deploy your app manually, check out the deployment documentation for full details.