AWS Amplify and Typescript with NextJS

Setup

Initialize and deploy the Amplify project

If you've never used amplify before

Sign up for an AWS account
Install the AWS Amplify cli:

npm install -g @aws-amplify/cli

Configure the Amplify cli

amplify configure

$ amplify init

? Enter a name for the environment: dev (or whatever you would like to call this env)
? Choose your default editor: <YOUR_EDITOR_OF_CHOICE>
? Do you want to use an AWS profile? Y

$ amplify push

? Are you sure you want to continue? Y
? Do you want to generate code for your newly created GraphQL API? Y

> We already have the GraphQL code generated for this project, so generating it here is not necessary.

Install & Run

npm install
npm run dev
# or
yarn
yarn dev

Edit GraphQL Schema

Open amplify/backend/api/nextjswithamplifyts/schema.graphql and change what you need to.
Run amplify push
👍

Use with new Amplify project

Make sure to commit your changes before doing this.

Detailed version

   $ mv amplify/backend/api/nextjswithamplifyts/schema.graphql ./schema.graphql
   $ rm -rf amplify/ src/
   $ amplify init

   ? Enter a name for the project <MY_PROJECT_NAME>
   ? Enter a name for the environment prod
   ? Choose your default editor: <MY_CODE_EDITOR>
   ? Choose the type of app that you're building javascript
   ? What javascript framework are you using react
   ? Source Directory Path: src
   next export outputs the project to the out directory
   ? Distribution Directory Path: out
   ? Build Command: default
   ? Start Command: default
   ? Do you want to use an AWS profile? (Y/n) Y
   ...
   Your project has been successfully initialized and connected to the cloud!

   $ amplify add api
   ? Please select from one of the below mentioned services
   GraphQL
   ? Provide API name: <MY_API_NAME>
   ? Choose an authorization type for the API (Use arrow keys)
   API key
   ? Do you have an annotated GraphQL schema? (y/N) y
   ? Provide your schema file path: ./schema.graphql

   $ rm ./schema.graphql
   $ amplify push
   ? Are you sure you want to continue? Yes
   ? Do you want to generate code for your newly created GraphQL API Yes
   ? Choose the code generation language target typescript
   ? Enter the file name pattern of graphql queries, mutations and subscriptions src/graphql/**/*.ts
   ? Do you want to generate/update all possible GraphQL operations - queries, mutations and subscriptions Yes
   ? Enter maximum statement depth [increase from default if your schema is deeply nested] 2
   ? Enter the file name for the generated code src/API.ts

mv amplify/backend/api/nextjswithamplifyts/schema.graphql ./schema.graphql
rm -rf amplify/ src/
amplify init
amplify add api
rm ./schema.graphql
amplify push

The idea behind this example

This repo shows how to build a server rendered web application with NextJS and AWS Amplify.

We use AWS Amplify to generate code and to manage and consume the AWS cloud resources needed for our app.

The NextJS app has dynamic and static routes to demonstrate how to load data on the server based on the incoming request.

Two routes are implemented :

/ : A static route that uses getInitialProps to load data from AppSync and renders it on the server (Code in pages/index.tsx)
/todo/[id] : A dynamic route that uses getInitialProps and the id from the provided context to load a single todo from AppSync and render it on the server. (Code in pages/todo/:[id].tsx)

You can read more about it here.

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

rakannimer / todolist-amplify-nextjs