You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: clarify supported Next.js versions and optional dependencies in installation guide (#15604)
Updates the installation docs to explicitly list supported Next.js
version ranges instead of the generic "version 15 or higher",
consolidates all software requirements into one section, notes that yarn
1.x is not supported, and separates required packages from optional ones
(`richtext-lexical`, `sharp`, `graphql`).
- Any JavaScript package manager (pnpm, npm, or yarn - pnpm is preferred)
13
+
- Any JavaScript package manager (pnpm, npm, or yarn 2+ - pnpm is preferred, yarn 1.x is not supported)
14
14
- Node.js version 20.9.0+
15
+
- Next.js (one of the following version ranges):
16
+
-`15.2.9` - `15.2.x`
17
+
-`15.3.9` - `15.3.x`
18
+
-`15.4.11` - `15.4.x`
19
+
-`16.2.0-canary.10`+
15
20
- Any [compatible database](/docs/database/overview) (MongoDB, Postgres or SQLite)
16
21
17
22
<Bannertype="warning">
18
23
**Important:** Before proceeding any further, please ensure that you have the
19
-
above requirements met.
24
+
above requirements met. Not all Next.js 15/16 releases are compatible — make
25
+
sure you're using one of the supported version ranges listed above.
20
26
</Banner>
21
27
22
28
## Quickstart with create-payload-app
23
29
24
30
To quickly scaffold a new Payload app in the fastest way possible, you can use [create-payload-app](https://npmjs.com/package/create-payload-app). To do so, run the following command:
25
31
26
-
```
32
+
```bash
27
33
npx create-payload-app
28
34
```
29
35
@@ -35,16 +41,22 @@ Adding Payload to an existing Next.js app is super straightforward. You can eith
35
41
36
42
If you don't have a Next.js app already, but you still want to start a project from a blank Next.js app, you can create a new Next.js app using `npx create-next-app` - and then just follow the steps below to install Payload.
37
43
38
-
<Bannertype="info">
39
-
**Note:** Next.js version 15 or higher is required for Payload.
40
-
</Banner>
41
-
42
44
#### 1. Install the relevant packages
43
45
44
-
First, you'll want to add the required Payload packages to your project and can do so by running the command below:
46
+
First, you'll want to add the required Payload packages to your project:
47
+
48
+
```bash
49
+
pnpm i payload @payloadcms/next
50
+
```
51
+
52
+
You'll also likely want to install the following optional packages:
53
+
54
+
-`@payloadcms/richtext-lexical` - Rich text editor (not needed if you don't use Rich Text)
55
+
-`sharp` - Image resizing, cropping, and focal point support (only needed if you use [Upload](/docs/upload/overview) collections with image manipulation)
56
+
-`graphql` - Only needed if you want to use the [GraphQL API](/docs/graphql/overview)
45
57
46
58
```bash
47
-
pnpm i payload @payloadcms/next @payloadcms/richtext-lexical sharp graphql
59
+
pnpm i @payloadcms/richtext-lexical sharp graphql
48
60
```
49
61
50
62
<Bannertype="warning">
@@ -116,9 +128,6 @@ import { withPayload } from '@payloadcms/next/withPayload'
0 commit comments