Skip to content

Files

Latest commit

 

History

History

image-processing-app

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
resources
resources
 
 
statemachine
statemachine
 
 
typescript
typescript
 
 
README.md
README.md
 
 
example-workflow.json
example-workflow.json
 
 

README.md

Image Processing App

This is a sample project that leverages AWS Cloud Development Kit (CDK) to deploy a serverless workflow using AWS Step Functions. The application makes external web service calls to retrieve cheque IDs and corresponding images. It then merges the front and back images for each chequeID and stores them in a designated storage bucket. Finally, the application creates a zip file containing all the cheque images for easy archiving and sharing.

Application automates the process of retrieving, merging and archiving cheque images from external web services making it more efficient and convenient for users.

Important: this application uses various AWS services and there are costs associated with these services after the Free Tier usage - please see the AWS Pricing page for details. You are responsible for any AWS costs incurred. No warranty is implied in this example.

Requirements

Deployment Instructions

  1. Create a new directory, navigate to that directory in a terminal and clone the GitHub repository:

    git clone https://github.com/aws-samples/image-processing-app [To be created upon approval]

  2. Change directory to the pattern directory:

    cd image-processing-app

  3. From the command line, use npm to install dependencies and run the build process.

    npm install

  4. From the command line, run the following cdk commands to synthesize an AWS CloudFormation template and deploy the app

    cdk bootstrap
cdk synth
cdk deploy

How it works

The CDK App deploys the following artifacts: A Dynamo DB Table to maintain the authenticity of the caller with the state execution ID An S3 Bucket to store the images. Lambda functions for following operations:

  • To pull the Cheque IDs
  • To pull the Front & Back Image of the ChequeID and Merge them into a consolidated jpeg.
  • To create a Zip file for all the images stored in the bucket.

Image

image

Testing

  1. Deploy the State Machine via CDK.

  2. For testing purposes, Upload test images [cheque-front-image.jpg and cheque-back-image.jpg] to any Amazon S3 bucket in your AWS Account.

  3. After uploading the image, generate a pre-signed URL for both the images and navigate to AWS Lambda function "sfn-GetCheque-Images" to update the pre-signed URL's.

    • const frontchqimage = "front_image_url_here";
    • const backchqimage = "back_image_url_here";

  4. Select Start Execution and observe the execution of the workflow.

  5. Workflow will now create the S3 bucket and start creating the files. The merged images will be created for all the ChequeID's that will be determined in "Get Cheque IDs" task. Map state asynchronously makes web service calls to pull the images for each chequeID, combines the images and stores them in the S3 Bucket.

  6. Finally a Zip file will be created in the final step of the execution for all the images from the bucket.

Cleanup

  1. To delete the resources created by this template:

Delete the stack

cdk destroy

cdk destroy

Copyright 2023 Amazon.com, Inc. or its affiliates. All Rights Reserved.

SPDX-License-Identifier: MIT-0