Skip to content

Commit b56b7c1

Browse files
committed
Editing README
1 parent 5116872 commit b56b7c1

File tree

4 files changed

+53
-34
lines changed

4 files changed

+53
-34
lines changed

README.md

Lines changed: 33 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
1+
<p align="center">
2+
<a href="https://open-next.js.org">
3+
<img alt="OpenNext" src="docs/public/logo.svg" width="300" />
4+
</a>
5+
</p>
16
<p align="center">
27
<a href="https://sst.dev/discord"><img alt="Discord" src="https://img.shields.io/discord/983865673656705025?style=flat-square" /></a>
38
<a href="https://www.npmjs.com/package/open-next"><img alt="npm" src="https://img.shields.io/npm/v/open-next.svg?style=flat-square" /></a>
49
</p>
510

6-
# OpenNext
11+
---
712

813
OpenNext takes the Next.js build output and converts it into a package that can be deployed to any functions as a service platform.
914

@@ -23,38 +28,38 @@ OpenNext aims to support all Next.js 13 features. Some features are work in prog
2328

2429
1. Naviate to your Next.js app
2530

26-
```bash
27-
cd my-next-app
28-
```
31+
```bash
32+
cd my-next-app
33+
```
2934

3035
2. Ensure [standalone output](https://nextjs.org/docs/advanced-features/output-file-tracing#automatically-copying-traced-files) is enabled in your `next.config.js`:
3136

32-
```diff
33-
/** @type {import('next').NextConfig} */
34-
const nextConfig = {
35-
+ output: "standalone"
36-
reactStrictMode: true,
37-
swcMinify: true,
38-
}
37+
```diff
38+
/** @type {import('next').NextConfig} */
39+
const nextConfig = {
40+
+ output: "standalone"
41+
reactStrictMode: true,
42+
swcMinify: true,
43+
}
3944

40-
module.exports = nextConfig
41-
```
45+
module.exports = nextConfig
46+
```
4247

4348
3. Build app
4449

45-
```bash
46-
npx open-next build
47-
```
50+
```bash
51+
npx open-next build
52+
```
4853

49-
This will generate an `.open-next` directory with the following bundles:
54+
This will generate an `.open-next` directory with the following bundles:
5055

51-
```bash
52-
my-next-app/
53-
.open-next/
54-
assets/ -> Static assets to upload to an S3 Bucket
55-
server-function/ -> Handler code for server Lambda Function
56-
middleware-function/ -> Handler code for middleware Lambda@Edge Function
57-
```
56+
```bash
57+
my-next-app/
58+
.open-next/
59+
assets/ -> Static assets to upload to an S3 Bucket
60+
server-function/ -> Handler code for server Lambda Function
61+
middleware-function/ -> Handler code for middleware Lambda@Edge Function
62+
```
5863

5964
## Recommeded infrastructure
6065

@@ -119,3 +124,7 @@ Create a PR and add a new page to the benchmark app in `example` with the issue.
119124
Vercel deploys the middleware code to edge functions, which gets invoked before the request reaches the CDN. This way, static pages can be cached. On request, middleware gets called, and then the CDK can send back cached response.
120125

121126
OpenNext is designed to adopt the same setup as Vercel. And building using `@vercel/next` allows us to separate the middleware code from the server code.
127+
128+
---
129+
130+
Maintained by [SST](https://sst.dev), join our community: [Discord](https://sst.dev/discord) | [YouTube](https://www.youtube.com/c/sst-dev) | [Twitter](https://twitter.com/SST_dev)

docs/pages/index.tsx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -22,8 +22,8 @@ export default function Home() {
2222
that can be deployed to any functions as a service platform.
2323
</p>
2424
<p>
25-
It supports all Next.js 13 features including, SSG, ISR, SSR, Image
26-
Optimization, and Middleware.
25+
The goal is to support all Next.js 13 features including, SSG, ISR,
26+
SSR, Image Optimization, and Middleware.
2727
</p>
2828
</section>
2929

@@ -53,8 +53,8 @@ export default function Home() {
5353
</p>
5454
<p>
5555
Next.js, unlike Remix or Astro, doesn't have a way to self-host using
56-
serverless. You can only run it in a Docker container. Containers are
57-
expensive and need to be scaled.
56+
serverless. You can run it as a Node application. This however doesn't
57+
work the same way as it does on Vercel.
5858
</p>
5959
</section>
6060

@@ -166,14 +166,14 @@ export default function Home() {
166166
<ol>
167167
<li>
168168
<p>
169-
Run <code>open-next build</code> to generate the <code>.open-next</code>{" "}
170-
directory.
169+
Run <code>open-next build</code> to generate the{" "}
170+
<code>.open-next</code> directory.
171171
</p>
172172
<p>
173-
This directory contains a zip
174-
file of your app that'll run in a Lambda function, a zip file
175-
that'll run the middleware Lambda@Edge function, and a zip fileectory
176-
containing your static assets that'll go to S3.
173+
This directory contains a zip file of your app that'll run in a
174+
Lambda function, a zip file that'll run the middleware Lambda@Edge
175+
function, and a zip fileectory containing your static assets
176+
that'll go to S3.
177177
</p>
178178
</li>
179179
<li>
File renamed without changes.

docs/public/logo.svg

Lines changed: 10 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)