aws-samples/subtitle-generator-cdk-app

Subtitle Generator - Cloud Application with AWS CDK

With this project, you can provision the infrastructure, backend, and frontend required for a subtitle generator with a AWS CDK.

Demo

Serverless Architecture

Prerequisites

1. AWS Account
2. A user with AdministratorAccess to your account to provision AWS resources for you like S3 Bucket, ApiGateway, Cloudfront, DynamoDB, Cognito, ETC.
3. Configuration and credential file settings - Please refer to the link to set the credentials on your computer.
4. Install AWS Cloud Development Kit (CDK) v2

Quick Start

1. $ git clone https://github.com/aws-samples/subtitle-generator-cdk-app
   $ cd subtitle-generator-cdk-app
   $ npm install
   $ npm run build
   $ cdk bootstrap
   $ cdk deploy --all --outputs-file ./cdk-outputs.json --require-approval never

   Please check for each stack provisioned through the terminal and type y to the question.
   Through this task, provision the architecture shown in the figure above. It takes approximately 15-30 minutes.
2. After the entire stack is deployed, check the cdk-outputs.json file and access the StaticWebDistributionUrl in StaticWebStack through your browser.
   (Ex: "StaticWebDistributionUrl": "xxxxxxxxx.cloudfront.net")
3. And copy the entire contents of cdk-outputs.json to the clipboard.
4. Paste the copied cdk-outputs.json into your browser and click the Submit button.
5. It's done! Now, sign up with a valid email account and try creating and editing multilingual subtitle files(.srt, .vtt) for your videos.

AWS Services and Pricing

• Amazon Transcribe
• Amazon Translate
• Amazon S3
• Amazon CloudFront
• Amazon Cognito
• Amazon API Gateway
• Amazon DynamoDB
• AWS Lambda
• AWS Step Functions

Useful commands

• npm run build compile typescript to js
• npm run watch watch for changes and compile
• npm run test perform the jest unit tests
• cdk deploy deploy this stack to your default AWS account/region
• cdk diff compare deployed stack with current state
• cdk synth emits the synthesized CloudFormation template

Clean-up

cdk destroy

If you don't need the subtitle generator anymore and want to remove all of its stack and resources, do this command.

subtitle-generator-cdk-app's Issues

TypeScript version

Hi Team,

I would like to ask to update the readme file and request to fix an error.

Build Error

I got an error message when I tried out to build this project.
It looked like, depending on TypeScript version.
I've got a success after updated my typescript version.

$ npm run build

> [email protected] build
> tsc

node_modules/@types/babel__traverse/index.d.ts:68:50 - error TS1005: ']' expected.

68 export type ArrayKeys<T> = keyof { [P in keyof T as T[P] extends any[] ? P : never]: P };
                                                    ~~

node_modules/@types/babel__traverse/index.d.ts:68:53 - error TS1005: ';' expected.

68 export type ArrayKeys<T> = keyof { [P in keyof T as T[P] extends any[] ? P : never]: P };
                                                       ~

node_modules/@types/babel__traverse/index.d.ts:68:58 - error TS1005: ';' expected.

68 export type ArrayKeys<T> = keyof { [P in keyof T as T[P] extends any[] ? P : never]: P };
                                                            ~~~~~~~

node_modules/@types/babel__traverse/index.d.ts:68:70 - error TS1011: An element access expression should take an argument.

68 export type ArrayKeys<T> = keyof { [P in keyof T as T[P] extends any[] ? P : never]: P };
                                                                        

node_modules/@types/babel__traverse/index.d.ts:68:83 - error TS1005: ';' expected.

68 export type ArrayKeys<T> = keyof { [P in keyof T as T[P] extends any[] ? P : never]: P };
                                                                                     ~

node_modules/@types/babel__traverse/index.d.ts:68:84 - error TS1128: Declaration or statement expected.

68 export type ArrayKeys<T> = keyof { [P in keyof T as T[P] extends any[] ? P : never]: P };
                                                                                      ~

node_modules/@types/babel__traverse/index.d.ts:68:88 - error TS1128: Declaration or statement expected.

68 export type ArrayKeys<T> = keyof { [P in keyof T as T[P] extends any[] ? P : never]: P };
                                                                                          ~


Found 7 errors.

Suggestion

I have a recommendation on ReadMe.md file.
I cannot deploy all deploy stack when I follow command on Quick Start section like below.

   $ cdk deploy --all --outputs-file ./cdk-outputs.json

How about add this option --require-approval never?
This option can skip the "Do you wish to deploy these changes (y/n)" check during a deployment.

Static web stack files missing?

Hi, Thanks for this awesome sample; I learned much from it.
But after the cdk deploy --all, I opened the URL in the StaticWebStack.StaticWebDistributionUrl output, and it seems some js files are missing.

Or I'm doing something wrong?

@masangbeom