From f391e3051f1179081ae9192abbb9c4b1837b7652 Mon Sep 17 00:00:00 2001 From: wiwium Date: Wed, 9 Feb 2022 00:44:55 +0530 Subject: [PATCH 1/2] Fixed Readme --- README.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a916140..a9685ab 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,22 @@ -# Welcome to your CDK TypeScript project! +# A AWS CDK startup template. -This is a blank project for TypeScript development with CDK. +A specially crafted AWS CDK template that is designed as a reference for a fully serverless application
+Simple, clean, and easy to get started with your custom requirements. -The `cdk.json` file tells the CDK Toolkit how to execute your app. +## Is it for you? +- Designed for beginners to quickly get started with AWS CDK. +- Uses python for the lambda backend and typescript for 'infrastructure as a code'. +- Stuck how to integrate AWS services with CDK? Or how to setup a python lambda testing pipeline? This template is for you to refer! -## Useful commands +## Architecture: -- `npm run build` compile typescript to js + +## Deploy: - `npm run watch` watch for changes and compile +- `npm run build` compile typescript to js - `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 +- `cdk deploy` deploy this stack to your default AWS account/region + +## Test lambda -> TODO: From 2495838ed3c16c45dbde8e291a92e84379e76dbe Mon Sep 17 00:00:00 2001 From: Ketan Chaudhari Date: Wed, 9 Feb 2022 00:46:39 +0530 Subject: [PATCH 2/2] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a9685ab..919f0fd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# A AWS CDK startup template. +# A AWS CDK Template. A specially crafted AWS CDK template that is designed as a reference for a fully serverless application
Simple, clean, and easy to get started with your custom requirements. @@ -9,6 +9,7 @@ Simple, clean, and easy to get started with your custom requirements. - Stuck how to integrate AWS services with CDK? Or how to setup a python lambda testing pipeline? This template is for you to refer! ## Architecture: +![architecture](https://user-images.githubusercontent.com/35309821/153059229-0b156d4b-d8df-418e-a0ff-7d63fb940443.png) ## Deploy: