A sample project leveraging AWS Amplify, AWS AppSync, AWS Lambda, Amazon DynamoDB, etc. This project (and a previous incarnation of it) was born out of a desire to test drive a number of new services released by AWS over the past months / year. These primarily include Amplify DataStore, Lambda Layers, Lambda support for Ruby, AWS Step Functions Nested Workflows, and a few others. The project was also an opportunity to build and test a few ideas in a more realistic application.
The resulting product is a news reader that aggregates the various AWS blogs, creating awareness of the content, and a single location to read it. In the future, the application will also attempt to recommend content across blogs.
Project is currently hosted at: https://news.iamjkahn.com.
AWS News is broadly composed of three primary components:
1. Frontend Built with Next.js, a React framework for building web applications, the frontend application is a static website served by AWS Amplify Console. Amazon Pinpoint captures user interaction data, streaming it for further processing to Kinesis Data Firehose.
2. Backend - Ingestion Blog post articles are ingested by a process orchestrated by AWS Step Function and executed by AWS Lambda. Articles are ingested by parsing the RSS feed of each AWS blog. Article metadata is stored in Amazon DynamoDB. The article content and a web-optimized image is stored in Amazon S3. New content events are published to Amazon EventBridge.
3. Backend - Data Plane Data for the application is available via GraphQL API built using AWS AppSync. The API exposes data stored in DynamoDB tables as well as an Amazon ElastiCache for Redis cluster (via a Lambda function). Amazon API Gateway serves article content and images.
AWS Amplify manages various aspects of the architecture (denoted by an asterisk in the diagram above), including AppSync, DynamoDB, Pinpoint, and S3. Additional resources are managed by Amazon CloudFormation stacks using the Serverless Application Model.
The application source code is broadly organized across the three categories above. CloudFormation templates and Lambda code for the Backend components are in the backend/ directory. The Next.js frontend application is in the next/ directory (note a previous version of the frontend in the web/ directory). The amplify/ directory is managed by the Amplify CLI and contains the resource configurations managed by Amplify. The support/ directory contains support for building AWS News using Amplify Console, more on this below.
AWS News has been built to allow deployment manually or by using the continuous deployment capabilities provided by Amplify Console. A Makefile is used to automate many of the common tasks involved in deploying the project.
AWS News requires the following prerequisites:
If you are deploying the project manually, without the use of Amplify Console, you will also need to install Ruby 2.7 and other supporting tools.
Note: AWS offers a Free Tier for many services, though not all used in this project are part of the Free Tier.
-
Fork this repository, note the URL in your GitHub account.
-
Ensure Docker is running.
-
Run the
deploy.supporttask to build a custom build image using Docker and push the image to a private image repository created in Amazon Elastic Container Registry. Note that building and then pushing the image can take some time, so grab a cup of coffee.
make deploy.supportWhy a custom build image? Amplify provides a flexible build image but also supports custom build image. For this project, I opted to take the custom route to streamline the image and enable support for Ruby 2.7.
-
Open your favorite browser and go to the AWS Console.
-
Navigate to Amplify Console. Here, we will enable our hosting environment as well as continous delivery by connecting a new project to the forked GitHub repository created earlier.
-
Select "Connect App" in Amplify Console.
-
Select GitHub and click "Continue". You may need to authorize Amplify to have access to your GitHub repository.
-
Select your forked
aws-newsrepository and themasterbranch. Click "Next". -
Amplify will automatically detect the React project as well as the custom build settings included in amplify.yml. Create a new backend environment and create a service role (if one does not exist).
-
Expand the "Advanced Settings" section. Copy and paste the URI of your custom build image, e.g. "1234567890.dkr.ecr.us-east-1.amazonaws.com/aws-news-builder-dev". This value was outputted at the end of the
deploy.supporttask or can be found by navigating to ECR in the AWS Console.
- Click "Continue" and confirm on the next screen. Then start your deployment. The initial deployment will take longer than subsquent updates, get another cup of coffee. When finished, Amplify Console will display a custom URL for the deployed application, but there will not be content yet.
The build process for AWS News makes use of AWS Systems Manager Parameter Store to pass configuration details between various CloudFormation stacks. This is an incredibly useful pattern for building complex infrastructure.
- To load content, navigate to Step Functions in the AWS Console. Find the state machine named
aws-news-load-blogs-<environment>. Click on the name of the state machine. On the next page, click the "Start execution" button at the top of the page. The state machine will load the initial list of AWS blogs and start ingestion of content from those blogs.
Step Functions provides a visual of progress, but you can also navigate to the
aws-news-process-blog-<environment>state machine to see individual blogs being processed.
- Navigate to the URL provided by Amplify Console to view AWS News. The frontend has been built to be responsive to screen size, so it will work well across your devices.
Where possible, the default configuration enables tracing using AWS X-Ray. If you would like to enable tracing of the Data API, you can do so by updating the configuration of the AppSync API.
make delete
amplify delete
This project is a work in progress. Please feel free to submit suggestions or pull requests.
- Enhance monitoring -- tracing, logging
- Modify Elasticache resolvers to use direct to Lambda
- Add personalization and auth needed
- iOS (SwiftUI)
- Josh Kahn - Initial work
Heitor Lessa's AWS Serverless Airline Booking project helped identify several useful patterns for managing deployment.
-
June 2020 - rework organization; add new SAM support for Step Functions; add new support for building layers
-
July/August 2020 -- implement SAM CLI GA support for building layers; migrate to direct lambda resolvers for AWS AppSync;add progressive loading of images to frontend; pre-process article image and convert to WebP format to improve speed (1, 2, 3)