/nextjs-deploy-example

Deploy NextJs SSR applications built using open-next to AWS Lambda.

Primary LanguageJavaScript

NextJs Construct Usage Example

This example deploys the example open-next application to AWS Lambda using AWS CDK.

What's inside?

This turborepo uses yarn as a package manager. It includes the following packages/apps:

Apps and Packages

  • web: open-next example app
  • ui: a stub React component library shared by both web and docs applications (unused)
  • eslint-config-custom: eslint configurations (includes eslint-config-next and eslint-config-prettier)
  • tsconfig: tsconfig.jsons used throughout the monorepo (includes cdk.json)

Utilities

This turborepo has some additional tools already setup for you:

Build

To build all apps and packages, run the following command:

cd nextjs-deploy-example
yarn run build

Develop

To develop all apps and packages, run the following command:

cd nextjs-deploy-example
yarn run dev

Open Next

To build with open-next:

yarn run opennext

Synth

To synthesize the cloudformation template:

yarn run synth

Deploy

To deploy the stack:

yarn run deploy

Info: The deployment uses default credentials from ~/.aws/credentials and can take several minutes.

Warning: The deploy command does not ask for confirmation.

Warning: The AWS region is defined at apps/hosting/bin/hosting.ts. AWS Lambda@Edge (yet to be implemented) requires the region to be us-east-1.

Remote Caching

Turborepo can use a technique known as Remote Caching to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.

By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can create one, then enter the following commands:

cd my-turborepo
npx turbo login

This will authenticate the Turborepo CLI with your Vercel account.

Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your turborepo:

npx turbo link

Apprisals

Useful Links

NextJs:

Turborepo: