Skip to content

Commit f1f8916

Browse files
committed
Update README
1 parent 4f9ada6 commit f1f8916

File tree

1 file changed

+20
-12
lines changed

1 file changed

+20
-12
lines changed

README.md

Lines changed: 20 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,13 +11,13 @@ OpenNext takes the Next.js build output and converts it into a package that can
1111

1212
OpenNext aims to support all Next.js 13 features. Some features are work in progress. Please open a [new issue](/issues/new) to let us know!
1313

14-
[x] API routes
15-
[x] Dynamic routes
16-
[x] Static site generation (SSG)
17-
[x] Server-side rendering (SSR)
18-
[x] Incremental static regeneration (ISR)
19-
[] Image optimization (work in progress)
20-
[] Middleware (work in progress)
14+
- [x] API routes
15+
- [x] Dynamic routes
16+
- [x] Static site generation (SSG)
17+
- [x] Server-side rendering (SSR)
18+
- [x] Incremental static regeneration (ISR)
19+
- [ ] Image optimization (work in progress)
20+
- [ ] Middleware (work in progress)
2121

2222
## Quick start
2323

@@ -27,6 +27,14 @@ Naviate to your Next.js app
2727
cd my-next-app
2828
```
2929

30+
Ensure the [`standalone` output](https://nextjs.org/docs/advanced-features/output-file-tracing#automatically-copying-traced-files) is enabled in your `next.config.js`:
31+
32+
```ts
33+
module.exports = {
34+
output: "standalone",
35+
};
36+
```
37+
3038
Build app
3139

3240
```bash
@@ -87,16 +95,16 @@ Then `open-next` transforms `@vercel/next`'s build output into a format that can
8795

8896
In the `example` folder, you can find a benchmark Next.js app. Here is a link deployed using SST's [`NextjsSite`](https://docs.sst.dev/constructs/NextjsSite) construct. It contains a handful of pages. Each page aims to test a single Next.js feature.
8997

90-
## Opening an issue
91-
92-
Create a PR and add a new page to the benchmark app in `example` with the issue.
93-
94-
### Debugging
98+
## Debugging
9599

96100
You can find the server log in the AWS CloudWatch console of the **region you deployed to**.
97101

98102
You can find the middleware log in the AWS CloudWatch console of the **region you are physically close to**. For example, if you deployed your app to `us-east-1` and you are in London, it's likely you will find the logs in `eu-west-2`.
99103

104+
## Opening an issue
105+
106+
Create a PR and add a new page to the benchmark app in `example` with the issue.
107+
100108
## FAQ
101109

102110
#### Why use the `@vercel/next` package for building the Next.js app?

0 commit comments

Comments
 (0)