4466ba436b
## Description This PR ensures that the default prettier config is used for examples and templates. This config is compatible with `prettier@3` as well (upgrading prettier is bigger change that can be a future PR). ## Changes - Updated `.prettierrc.json` in root with `"trailingComma": "es5"` (will be needed upgrading to prettier@3) - Added `examples/.prettierrc.json` with default config (this will change every example) - Added `packages/create-next-app/templates/.prettierrc.json` with default config (this will change every template) ## Related - Fixes #54402 - Closes #54409 |
||
|---|---|---|
| .. | ||
| app | ||
| components | ||
| css | ||
| pages/api | ||
| payload | ||
| public | ||
| utilities | ||
| .env.example | ||
| .gitignore | ||
| .npmrc | ||
| cssVariables.js | ||
| next-env.d.ts | ||
| next-env.scss.d.ts | ||
| next.config.js | ||
| package.json | ||
| payload-types.ts | ||
| README.md | ||
| tsconfig.json | ||
Next + Payload Serverless Demo
This is a demo showing how to utilize @payloadcms/next-payload to deploy Payload serverlessly, in the same repo alongside of a Next.js app.
Deploy your own
Deploy the example using Vercel:
How to use
Execute create-next-app with npm, Yarn, or pnpm to bootstrap the example:
npx create-next-app --example cms-payload cms-payload-app
yarn create next-app --example cms-payload cms-payload-app
pnpm create next-app --example cms-payload cms-payload-app
Deploy it to the cloud with Vercel (Documentation).
The only thing you need to do to deploy to Vercel is to ensure that you have a Mongo Atlas database connection string and an S3 bucket (if desired).
Fill out the same environment variables that are shown in the .env.example with your own values, and then you're good to go!
Developing locally
To develop with this package locally, make sure you have the following required software:
- MongoDB
- Node + NPM / Yarn
- An S3 bucket to store media (optional)
Getting started
Follow the steps below to spin up a local dev environment:
- Clone the repo
- Run
yarnornpm install - Run
cp .env.example .envand fill out all ENV variables as shown - Run
yarn devto start up the dev server
From there, you can visit your admin panel via navigating to http://localhost:3000/admin. Go ahead and start working!