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
Copy file name to clipboardExpand all lines: README.md
+32-3Lines changed: 32 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -59,6 +59,34 @@ my-next-app/
59
59
60
60
## Deployment
61
61
62
+
OpenNext allows you to deploy your Next.js apps using a growing list of frameworks.
63
+
64
+
### SST
65
+
66
+
The easiest way to deploy OpenNext to AWS is with [SST](https://docs.sst.dev/start/nextjs). This is maintained by the OpenNext team and only requires three simple steps:
67
+
68
+
1. Run `npx create-sst@latest` in your Next.js app
69
+
2. Run `npm install`
70
+
3. Deploy to AWS `npx sst deploy`
71
+
72
+
For more information, check out the SST docs: https://docs.sst.dev/start/nextjs
73
+
74
+
### Other Frameworks
75
+
76
+
The OpenNext community has contributed deployment options for a few other frameworks.
To use these, you'll need to run the following inside your Next.js app.
83
+
84
+
```bash
85
+
$ npx open-next@latest build
86
+
```
87
+
88
+
If you are using OpenNext to deploy using a framework that is not listed here, please let us know so we can add it to the list.
89
+
62
90
## Recommended infrastructure on AWS
63
91
64
92
OpenNext does not create the underlying infrastructure. You can create the infrastructure for your app with your preferred tool — SST, AWS CDK, Terraform, Serverless Framework, etc.
@@ -264,9 +292,10 @@ To work around the issue, we change the working directory for the server functio
264
292
265
293
## Example
266
294
267
-
In the `example` folder, you can find a Next.js feature test app. It contains a variety of pages that each test a single Next.js feature.
295
+
In the `example` folder, you can find a Next.js benchmark app. It contains a variety of pages that each test a single Next.js feature. The app is deployed to both Vercel and AWS using [SST](https://docs.sst.dev/start/nextjs).
268
296
269
-
Here's a link deployed using SST's [`NextjsSite`](https://docs.sst.dev/constructs/NextjsSite) construct.
297
+
AWS link: https://d1gwt3w78t4dm3.cloudfront.net
298
+
Vercel link: https://open-next.vercel.app
270
299
271
300
## Debugging
272
301
@@ -295,7 +324,7 @@ It is recommended to **turn off debug mode when building for production** becaus
295
324
296
325
## Opening an issue
297
326
298
-
To open an issue, create a pull request (PR) and add a new page to the benchmark app in `example` folder that demonstrate the issue.
327
+
To open an issue, create a pull request (PR) and add a new page to the [benchmark app](#example) in `example` folder that demonstrate the issue.
0 commit comments