Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jetbridge/cdk-nextjs
Deploy a NextJS application using AWS CDK
https://github.com/jetbridge/cdk-nextjs
aws cdk cloudfront lambda next nextjs serverless
Last synced: about 2 hours ago
JSON representation
Deploy a NextJS application using AWS CDK
- Host: GitHub
- URL: https://github.com/jetbridge/cdk-nextjs
- Owner: jetbridge
- License: apache-2.0
- Created: 2022-09-30T23:32:38.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-03T11:47:25.000Z (4 months ago)
- Last Synced: 2024-10-29T17:11:38.471Z (about 1 month ago)
- Topics: aws, cdk, cloudfront, lambda, next, nextjs, serverless
- Language: TypeScript
- Homepage: https://constructs.dev/packages/cdk-nextjs-standalone
- Size: 8.5 MB
- Stars: 279
- Watchers: 3
- Forks: 46
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome - jetbridge/cdk-nextjs - Deploy a NextJS application using AWS CDK (TypeScript)
README
# Deploy NextJS with CDK
[](https://constructs.dev/packages/cdk-nextjs-standalone)
## What is this?
A CDK construct to deploy a NextJS app using AWS CDK.
Supported NextJs versions: >=12.3.0+ (includes 13.0.0+)
Uses the [standalone output](https://nextjs.org/docs/advanced-features/output-file-tracing) build mode.
## Quickstart
```ts
import { App, Stack, StackProps } from 'aws-cdk-lib';
import { Construct } from 'constructs';
import { Nextjs } from 'cdk-nextjs-standalone';
class WebStack extends Stack {
constructor(scope: Construct, id: string, props?: StackProps) {
super(scope, id, props);
const nextjs = new Nextjs(this, 'Nextjs', {
nextjsPath: './web', // relative path from your project root to NextJS
});
new CfnOutput(this, "CloudFrontDistributionDomain", {
value: nextjs.distribution.distributionDomain,
});
}
}
const app = new App();
new WebStack(app, 'web');
```
## Important Notes
- Due to CloudFront's Distribution Cache Behavior pattern matching limitations, a cache behavior will be created for each top level file or directory in your `public/` folder. CloudFront has a soft limit of [25 cache behaviors per distribution](https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/cloudfront-limits.html#limits-web-distributions). Therefore, it's recommended to include all assets that can be under a top level folder like `public/static/`. Learn more in open-next docs [here](https://github.com/sst/open-next/blob/main/README.md#workaround-create-one-cache-behavior-per-top-level-file-and-folder-in-public-aws-specific).
## Documentation
Available on [Construct Hub](https://constructs.dev/packages/cdk-nextjs-standalone/).
## Examples
See example CDK apps [here](./examples) including:
- App Router
- Pages Router
- App/Pages Router
- High Security
- Multiple Sites
To deploy an example, make sure to read the [README.md](./examples/README.md)
### Discord Chat
We're in the #open-next channel on the [Serverless Stack Discord](https://discord.gg/sst).
## About
Deploys a NextJs static site with server-side rendering and API support. Uses AWS lambda and CloudFront.
There is a new (since Next 12) [standalone output mode which uses output tracing](https://nextjs.org/docs/advanced-features/output-file-tracing) to generate a minimal server and static files.
This standalone server can be converted into a CloudFront distribution and a lambda handler that handles SSR, API, and routing.
The CloudFront default origin first checks S3 for static files and falls back to an HTTP origin using a lambda function URL.
## Benefits
This approach is most compatible with new NextJs features such as ESM configuration, [middleware](https://nextjs.org/docs/advanced-features/middleware), next-auth, and React server components ("appDir").
The unmaintained [@serverless-nextjs project](https://github.com/serverless-nextjs/serverless-next.js) uses the deprecated `serverless` NextJs build target which [prevents the use of new features](https://github.com/serverless-nextjs/serverless-next.js/pull/2478).
This construct was created to use the new `standalone` output build and newer AWS features like lambda function URLs and fallback origins.
You may want to look at [Serverless Stack](https://sst.dev) and its [NextjsSite](https://docs.sst.dev/constructs/NextjsSite) construct for an improved developer experience if you are building serverless applications on CDK.
## Dependencies
Built on top of [open-next](https://open-next.js.org/), which was partially built using the original core of cdk-nextjs-standalone.
## Heavily based on
- [Open-next](https://open-next.js.org/)
-
-
-
- [Serverless Stack](https://github.com/serverless-stack/sst)
- [RemixSite](https://github.com/serverless-stack/sst/blob/master/packages/resources/src/NextjsSite.ts) construct
- [NextjsSite](https://github.com/serverless-stack/sst/blob/master/packages/resources/src/RemixSite.ts) construct
## Contribute
See [Contribute](./docs/contribute.md).
## Breaking changes
See [Major Changes](./docs/major-changes.md).