search

datasprayio / open-next-cdk

Deploy a NextJS application using AWS CDK
https://constructs.dev/packages/open-next-cdk
Apache License 2.0
14 stars 1 forks source link

readme

Typescript Java Go Python .NET
OpenNext CDK

Build Status License NPM release

Deploy NextJS on AWS using CDK IaC and OpenNext packaging

Contents

What is this?

A building block for Amazon's infrastructure-as-code CDK toolkit to deploy a NextJS app using AWS serverless services.

Your NextJS app is packaged using OpenNext to fit the serverless format on Lambda

Requirements

NextJs versions: >=12.3.0+ (includes 13.0.0+)

Platforms: darwin-arm64, darwin-x64, linux-arm64, linux-x64, win32-arm64, win32-x64

Quickstart

NextJS setup

Add a dev dependency esbuild@0.17.16 to your NextJS project.

npm install --save-dev esbuild@0.17.16

CDK Construct

Use this construct in your CDK application to deploy your NextJS app to AWS.

Typescript Typescript NPM release Install the dependency using npm: ```shell npm install --save-dev esbuild@0.17.16 open-next-cdk ``` Use the construct in your CDK application: ```ts import { Nextjs } from 'open-next-cdk'; new Nextjs(this, 'Web', { nextjsPath: './web', // relative path to nextjs project root }); ```
Java Java Maven Central release Install the dependency using Maven: ```xml io.dataspray open-next-cdk x.y.z ``` Use the construct in your CDK application: ```java Nextjs.Builder.create(this, getConstructId()) .nextjsPath("./web") .build(); ```
Go Go Go release Install the dependency: ```shell go get github.com:datasprayio/open-next-cdk.git@go ``` Or checkout [the code in the `go` branch](https://github.com/datasprayio/open-next-cdk/tree/go).
Python Python Pypi release Install the dependency: ```shell pip install open-next-cdk ```
.NET .NET Nuget release Install the dependency: ```shell dotnet add package Dataspray.OpenNextCdk ```


This will automatically build your NextJS app and package it for you as part of the CDK construct.

If you would prefer to package it separately, see below:

Advanced

Pre-built OpenNext package

How-to You may also provide already pre-built OpenNext package directly by building it yourself first: ```shell open-next build ``` You will find a new folder `.open-next` which contains the packaging for your NextJS App. Now you can use the construct by instructing it not to build your app, just use the OpenNext folder directly: ```ts import { Nextjs } from 'open-next-cdk'; new Nextjs(this, 'Web', { openNextPath: './web/.open-next', // relative path to .open-next folder }); ```

Additional security

How-to ```ts import { RemovalPolicy, Stack } from "aws-cdk-lib"; import { Construct } from "constructs"; import { CfnWebAcl } from "aws-cdk-lib/aws-wafv2"; import { SecurityPolicyProtocol, type DistributionProps } from "aws-cdk-lib/aws-cloudfront"; import { Nextjs, type NextjsDistributionProps } from "cdk-nextjs-standalone"; import { Bucket, BlockPublicAccess, BucketEncryption } from "aws-cdk-lib/aws-s3"; // Because of `WebAcl`, this stack must be deployed in us-east-1. If you want // to deploy Nextjs in another region, add WAF in separate stack deployed in us-east-1 export class UiStack { constructor(scope: Construct, id: string) { const webAcl = new CfnWebAcl(this, "WebAcl", { ... }); new Nextjs(this, "NextSite", { nextjsPath: "...", defaults: { assetDeployment: { bucket: new Bucket(this, "NextjsAssetDeploymentBucket", { autoDeleteObjects: true, removalPolicy: RemovalPolicy.DESTROY, encryption: BucketEncryption.S3_MANAGED, enforceSSL: true, blockPublicAccess: BlockPublicAccess.BLOCK_ALL, }), }, distribution: { functionUrlAuthType: FunctionUrlAuthType.AWS_IAM, cdk: { distribution: { webAclId: webAcl.attrArn, minimumProtocolVersion: SecurityPolicyProtocol.TLS_V1_2_2021, } as DistributionProps, }, } satisfies Partial, }, }); } } ```


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 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, next-auth, and React server components ("appDir").

The unmaintained @serverless-nextjs project uses the deprecated serverless NextJs build target which prevents the use of new features. 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 and its NextjsSite construct for an improved developer experience if you are building serverless applications on CDK.

Dependencies

Built on top of open-next, which was partially built using the original core of cdk-nextjs-standalone.

Similar projects

This project is heavily based on

Fork from cdk-nextjs

Compatible with: cdk-nextjs@3.2.1

This project has been initially forked from cdk-nextjs in order to publish the package to other langugages. So far notable changes are:

Contributing

Hey there, we value every new contribution a lot 🙏🏼 thank you. Open an issue or a PR and we'll gladly help you out.

Using Projen

Most boilerplate files are pre-generated including package.json. Don't update it directly, rather update .projenrc.js then run yarn projen to re-generate the files.