Skip to content

Latest commit

 

History

History
130 lines (109 loc) · 6.27 KB

README.md

File metadata and controls

130 lines (109 loc) · 6.27 KB
Raw

React-Cognito-AppSync

This is a serverless project to play with React, Chakra UI, Apollo Client, Cognito, AppSync, Lambda, S3 and DynamoDB. It's developed using the AWS CDK and structured following best practices.

The application is organized into logical units, such as React site, GraphQL API, Cognito user pool, database and deployment pipeline. These logical units are implemented as CDK Constructs, which include the AWS resources definitions and sometimes also the runtime code. The constructs are later group in CDK Stacks, which define the deployment models.

The CDK, Lambda functions and React code is written in TypeScript.

Current Functionalities

  • Cognito sign in/sign out
  • Cognito new user
  • Cognito change/reset password
  • Small AWS resources dashboard
  • Write/Read DynamoDB table
  • List/Upload S3 files

Architecture

This application uses Cognito user pools for authentication and user management. Cognito identity pools is also used to generate temporary AWS credentials to manage files on the S3 bucket. AppSync is used to implement the GraphQL API and some of the operations run on Lambda Functions. There's also a DynamoDB table with data that is written and read directly from AppSync using VTL templates or through the Lambda functions. The website is hosted in a S3 bucket with a CloudFront distribution in front.

Project Structure

Each logical unit has a directory that includes the related infrastructure, runtime and configuration code. This way, any developer can easily find the code related to a specific logical unit.

.
├── cognito
|   |── cdk.ts                      # CDK construct with Cognito User Pool configuration
|
├── database
|   |── cdk.ts                      # CDK construct with DynamoDB table resource
| 
├── graphql-api
|   |── cdk.ts                      # CDK construct with AppSync and Lambda functions resources
|   |── <Lambda_Function_Name>      # A folder for each Lambda function with the name
|   |   |── index.ts                # Code for Lambda handler  
|   |── schema.graphql              # GraphQL schema
|   |── packages.json               # packages that needs to be bundle with the Lambda
|
├── pipeline                
|   |── cdk.ts                      # CDK construct for deployment pipeline
|
├── s3-files-bucket
|   ├── cdk.ts                      # CDK construct for S3 files bucket
|
├── s3-react-app                    # React application
|   |── cdk.ts                      # CDK construct for static website configuration
|   |── src                         # React application code
|   |── packages.json               # packages for React app
|   |── tsconfig.json               # React TypeScript configuration
|   |── linters and formatters for React code (.eslintrc.json, prettierrc)  
|
|── scripts                         # Useful scripts         
|
|── app.ts                          # Main CDK application (Constructs are imported here and deployed within Stacks)
|
|── CDK linters, packages and TypeScript configuration (.eslintrc.json, tsconfig.json)
|
└── ...

How to deploy

You can fork this repository and clone it to your local environment.

Then, if you want to deploy the application manually from your computer, please follow the next steps:

  1. yarn install
  2. You can change the name of the app in the app.js file. The default name is React-App
  3. Specify the AWS account number in the following environment variable 
    export AWS_ACCOUNT=
  4. Deploy the following CDK stacks in this order 
    yarn run cdk deploy <app-name>-CognitoStack <app-name>-TableStack`
yarn run cdk deploy <app-name>-AppSyncStack`
  5. Configure the following environment variables 
    export REACT_APP_USER_POOL_ID=
export REACT_APP_WEBCLIENT_ID=
export REACT_APP_API_URL=
export DEPLOY_SITE=true
  6. Build the React app 
    cd s3-react-ap && yarn build
  7. Deploy the static website 
    yarn run cdk deploy <app-name>-StaticSiteStack`
  8. Create the first Cognito user 
    npx ts-node scripts/create_cognito_user.ts 'email_address' 'name' 'last_name' Admin
  9. You are ready to log into the app! Get the URL from the <app-name>-StaticSiteStack output in the previous step. You can also log into the AWS console and find it in the CloudFront distribution.

To deploy the application through the deployment pipeline, follow these steps:

  1. Create AWS CodeStart GitHub connection
    • Create SSM parameter for the connection ARN and assign the following name Github-Connection
  2. Perform steps 2 and 3 from manual deployment above
  3. Modify the app.js file and enter your Github user and the repo name
new CodePipelineStack(app, 'DeploymentPipelineStack', {
  repoOwner: <github_user>,
  repoName: <repo_name>
})
  1. yarn install
  2. yarn run cdk deploy <app-name>-Pipeline-Stack
  3. Please notice that you will have to run the deployment pipeline a few times when deploying the app for the first time. This's because of some dependencies between stacks. I could've declared these dependencies manually in the CDK, but then every time you would deploy a change manually, it would take longer, and the same would also apply to the pipeline. The idea is to speed up the deployments and feedback loop.
  4. Perform step 8 from above

Useful commands

  • cdk deploy deploy stacks to your AWS account/region
  • cdk diff compare deployed stack with current state
  • cdk synth emits the synthesized CloudFormation template

Application Screenshots