Serverless OpenNext

Use Serverless and OpenNext to deploy your Next.js app to AWS.

Installation

Add this package to your Next.js project, along with Serverless
``
yarn add -D serverless-open-next serverless


OR


npm install --save-dev serverless-open-next serverless
`

Create a serverless.yml file with at least the bare minimum:
`yaml
frameworkVersion: "^3"
service: my-next-app
provider:
name: aws
region: eu-central-1
runtime: nodejs20.x
plugins:
- serverless-open-next
`

Deploy using
`
yarn exec serverless deploy --stage dev


OR


npm exec -- serverless deploy --stage dev
`

Customisation

Custom domain name

To assign a custom domain to your CloudFront distribution,
you need to request a certificate in the us-east-1 region.
Once that is issued, you can assign the ARN and domains to
the deployed CloudFront distribution by adding the following to
serverless.yml:

`yaml
custom:
open-next:
aliases: ... # Specify the domains you want to assign to CloudFront as a comma-separated string or array
# Examples:
# aliases: primary.tld
# aliases: primary.tld,www.primary.tld
# aliases: [primary.tld, www.primary.tld]
# aliases: !Ref MyDomainParameter
certificate: ... # Specify the ARN of the certificate to assign to CloudFront
``

Tip: you can use Serverless Compose to deploy the certificate to us-east-1,
and deploy the app to another region.

Architecture

This package will deploy several resources to your AWS account,
which for small projects should all fall in the free tier.

- S3 bucket for assets
- Lambda for the server part
- Lambda with custom role for image optimisation
- IAM policy to allow server part access to S3
- CloudFront distribution

Features

- SSR
- SSG
- API routes
- Middleware
- Image Optimization
- Fonts

Roadmap

- ISR with proper cache
- Revalidation function
- Warmer function
- Customisation of functions/resources

Acknowledgments

This project is built on these awesome projects:

- Serverless Framework
- OpenNext
- Next.js