Skip to content

Commit 707e85e

Browse files
authored
templates: add new readme for quick start on vercel platform (#11131)
1 parent 09ada20 commit 707e85e

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

templates/with-vercel-website/README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,36 @@ Core features:
2727
- [Jobs and Scheduled Publishing](#jobs-and-scheduled-publish)
2828
- [Website](#website)
2929

30-
## Quick Start
30+
## Quick start
3131

32-
To spin up this example locally, follow these steps:
32+
Click the 'Deploy' button above to spin up this template directly into Vercel hosting. It will first prompt you save this template into your own Github repo so that you own the code and can make any changes you want to it.
33+
34+
Set up the following services and secrets and then once the app has been built and deployed you will be able to visit your site at the generated URL.
35+
From this point on you can access your admin panel at `/admin` of your app URL, create an admin user and then click the 'Seed the database' button in the dashboard to add content into your app.
36+
37+
### Services
38+
39+
This project uses the following services integrated into Vercel which you will need to click "Add" and "Connect" for:
40+
41+
Neon Database - Postgres-based cloud database used to host your data
42+
43+
Vercel Blob Storage - object storage used to host your files such as images and videos
44+
45+
The connection variables will automatically be setup for you on Vercel when these services are connected.
46+
47+
#### Secrets
48+
49+
You will be prompted to add the following secret values to your project. These should be long unguessable strong passwords, you can also use a password manager to generate one for these.
50+
51+
CRON_SECRET - used for running cron on Vercel
52+
53+
PAYLOAD_SECRET - used by Payload to sign secrets like JWT tokens
54+
55+
PREVIEW_SECRET - used by Payload for secured live previews of your content
56+
57+
## Quick Start - local setup
58+
59+
To spin up this template locally, follow these steps:
3360

3461
### Clone
3562

0 commit comments

Comments
 (0)