Run a first e-store example

Start with the smallest workflow described by the README for e-store. Complete installation and configuration first.

Quick Start

To spin up this example locally, follow these steps:

Clone

If you have not done so already, you need to have standalone copy of this repo on your machine. If you've already cloned this repo, skip to Development.

Method 1 (recommended)

Go to Payload Cloud and clone this template. This will create a new repository on your GitHub account with this template's code which you can then clone to your own machine.

Method 2

Use the create-payload-app CLI to clone this template directly to your machine:

1npx create-payload-app@latest my-project -t website

Method 3

Use the git CLI to clone this template directly to your machine:

1git clone -n --depth=1 --filter=tree:0 https://github.com/payloadcms/payload my-project && cd my-project && git sparse-checkout set --no-cone templates/website && git checkout && rm -rf .git && git init && git add . && git mv -f templates/website/{.,}* . && git add . && git commit -m "Initial commit"

Development

First clone the repo if you have not done so already
cd my-project && cp .env.example .env to copy the example environment variables
yarn && yarn dev to install dependencies and start the dev server
open http://localhost:3000 to open the app in your browser

That's it! Changes made in ./src will be reflected in your app. Follow the on-screen instructions to login and create your first admin user. Then check out Production once you're ready to build and serve your app, and Deployment when you're ready to go live.

Verify your changes

The root manifest provides this check:

1npm run build

Read any errors before continuing. Build and type checks verify source consistency; exercise the README example to verify the behavior you need.

Next task

Read the usage guide for the documented components, configuration, and source layout.

Source and help