Skip to content

Commit dc3a892

Browse files
committed
Update doc
1 parent c140daf commit dc3a892

File tree

1 file changed

+32
-3
lines changed

1 file changed

+32
-3
lines changed

README.md

Lines changed: 32 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,34 @@ my-next-app/
5959

6060
## Deployment
6161

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.
77+
78+
- CDK: https://github.com/jetbridge/cdk-nextjs
79+
- CloudFormation: https://github.com/serverless-stack/open-next/issues/32
80+
- Serverless Framework: https://github.com/serverless-stack/open-next/issues/32
81+
82+
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+
6290
## Recommended infrastructure on AWS
6391

6492
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
264292

265293
## Example
266294

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).
268296

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
270299

271300
## Debugging
272301

@@ -295,7 +324,7 @@ It is recommended to **turn off debug mode when building for production** becaus
295324

296325
## Opening an issue
297326

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.
299328

300329
## Contribute
301330

0 commit comments

Comments
 (0)