Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created Readme #3

Merged
merged 2 commits into from
Feb 9, 2022
Merged

Created Readme #3

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f391e30
Fixed Readme
ketan-10 Feb 8, 2022
2495838
Update README.md
Feb 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,23 @@
# Welcome to your CDK TypeScript project!
# A AWS CDK 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 <br>
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:
![architecture](https://user-images.githubusercontent.com/35309821/153059229-0b156d4b-d8df-418e-a0ff-7d63fb940443.png)

- `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: