| # 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 | |
| [](https://vercel.com/new/git/external?repository-url=https://github.com/vercel/next.js/tree/canary/examples/cms-payload&project-name=cms-payload&repository-name=cms-payload) | |
| ## How to use | |
| Execute [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app) with [npm](https://docs.npmjs.com/cli/init), [Yarn](https://yarnpkg.com/lang/en/docs/cli/create/), or [pnpm](https://pnpm.io) to bootstrap the example: | |
| ```bash | |
| npx create-next-app --example cms-payload cms-payload-app | |
| ``` | |
| ```bash | |
| yarn create next-app --example cms-payload cms-payload-app | |
| ``` | |
| ```bash | |
| pnpm create next-app --example cms-payload cms-payload-app | |
| ``` | |
| Deploy it to the cloud with [Vercel](https://vercel.com/new?utm_source=github&utm_medium=readme&utm_campaign=next-example) ([Documentation](https://nextjs.org/docs/deployment)). | |
| 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: | |
| 1. MongoDB | |
| 2. Node + NPM / Yarn | |
| 3. An S3 bucket to store media (optional) | |
| ### Getting started | |
| Follow the steps below to spin up a local dev environment: | |
| 1. Clone the repo | |
| 2. Run `yarn` or `npm install` | |
| 3. Run `cp .env.example .env` and fill out all ENV variables as shown | |
| 4. Run `yarn dev` to 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! | |
| ### Related examples | |
| - [AgilityCMS](/examples/cms-agilitycms) | |
| - [Builder.io](/examples/cms-builder-io) | |
| - [ButterCMS](/examples/cms-buttercms) | |
| - [Contentful](/examples/cms-contentful) | |
| - [Cosmic](/examples/cms-cosmic) | |
| - [DatoCMS](/examples/cms-datocms) | |
| - [DotCMS](/examples/cms-dotcms) | |
| - [Drupal](/examples/cms-drupal) | |
| - [Enterspeed](/examples/cms-enterspeed) | |
| - [Ghost](/examples/cms-ghost) | |
| - [GraphCMS](/examples/cms-graphcms) | |
| - [Kontent.ai](/examples/cms-kontent-ai) | |
| - [MakeSwift](/examples/cms-makeswift) | |
| - [Payload](/examples/cms-payload) | |
| - [Plasmic](/examples/cms-plasmic) | |
| - [Prepr](/examples/cms-prepr) | |
| - [Prismic](/examples/cms-prismic) | |
| - [Sanity](/examples/cms-sanity) | |
| - [Sitecore XM Cloud](/examples/cms-sitecore-xmcloud) | |
| - [Sitefinity](/examples/cms-sitefinity) | |
| - [Storyblok](/examples/cms-storyblok) | |
| - [TakeShape](/examples/cms-takeshape) | |
| - [Tina](/examples/cms-tina) | |
| - [Umbraco](/examples/cms-umbraco) | |
| - [Umbraco heartcore](/examples/cms-umbraco-heartcore) | |
| - [Webiny](/examples/cms-webiny) | |
| - [WordPress](/examples/cms-wordpress) | |
| - [Blog Starter](/examples/blog-starter) | |