Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/skdishansachin/serverless-image-moderation
https://github.com/skdishansachin/serverless-image-moderation
aws aws-lambda aws-rekognition aws-s3 moderation
Last synced: 9 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/skdishansachin/serverless-image-moderation
- Owner: skdishansachin
- License: unlicense
- Created: 2024-12-22T04:06:58.000Z (18 days ago)
- Default Branch: main
- Last Pushed: 2024-12-22T05:49:16.000Z (18 days ago)
- Last Synced: 2024-12-22T06:25:38.385Z (18 days ago)
- Topics: aws, aws-lambda, aws-rekognition, aws-s3, moderation
- Language: TypeScript
- Homepage:
- Size: 56.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# serverless-image-moderation-cdk
## About
This is a serverless image moderation service. The service uses Amazon Rekognition to detect unsafe images and Amazon S3 to store the images. The service is built using AWS CDK and is written in Typescript.
## Use Case
### Scenario 1
Think of a company like Unsplash or Pexels that allows users to upload images that are publicly available. The company wants to ensure that no unsafe/inappropriate images are uploaded to the platform. The company can use this service to automatically detect unsafe images and take appropriate action like flagging the image, moving the image to a quarantine bucket or deleting the image.
## Architecture
Lambda function is triggered when an image is uploaded to the S3 bucket. The Lambda function uses Amazon Rekognition to detect unsafe images. If an unsafe image is detected, the image is moved to a quarantine S3 bucket. If the image is safe, the image will stay in the original S3 bucket.
## Pre-requisites
- Node.js
- AWS CLI (configured with the necessary permissions)
- AWS CDK (installed globally)
## Project Structure
This is a default project sturecture that AWS CDK provides. The `lib` directory contains the main stack file. The `bin` directory contains the entry point for the CDK application. The `lambda` directory contains the lambda function code.
- `lambda/image-moderation.ts` - Code for the Lambda function that is triggered when an image is uploaded to the S3 bucket.
## Deployment
To deploy the CDK application, run `cdk deploy` in the root directory of the project. This will deploy the stack to your default AWS account.
**Note:** If this is the first time you are deploying a CDK application, you will be prompted to bootstrap the CDK toolkit. Run `cdk bootstrap` to do this.
**Note:** If you have multiple AWS profiles, you can specify the profile to use by running `cdk deploy --profile `.
## Cleanup
To delete the stack, run `cdk destroy` in the root directory of the project.
## Resources
- [AWS CDK Documentation](https://docs.aws.amazon.com/cdk/api/v2/)
- [AWS CLI](https://aws.amazon.com/cli/)
- [Amazon Rekognition](https://aws.amazon.com/rekognition/)
- [Amazon S3](https://aws.amazon.com/s3/)
- [AWS Lambda](https://aws.amazon.com/lambda/)
## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.