Skip to content

Update README.md to be more visual #518

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

Merged
merged 4 commits into from
Dec 8, 2024
Merged

Update README.md to be more visual #518

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
738f4aa
Update README.md to be more visual
pethers Dec 3, 2024
80d0a12
Merge branch 'main' into pethers/update-readme-visual
pethers Dec 5, 2024
163b47e
Merge branch 'main' into pethers/update-readme-visual
pethers Dec 8, 2024
c323156
Merge branch 'main' into pethers/update-readme-visual
pethers Dec 8, 2024
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
42 changes: 31 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@

# Lambda in Private VPC

Check notice on line 1 in README.md

View workflow job for this annotation

GitHub Actions / StandardLint audit

Documentation 

Check for README file

**Status:** Work in Progress

Expand All @@ -11,7 +10,6 @@
[![Verify and Deploy](https://github.com/Hack23/lambda-in-private-vpc/actions/workflows/main.yml/badge.svg)](https://github.com/Hack23/lambda-in-private-vpc/actions/workflows/main.yml)
[![Scorecard supply-chain security](https://github.com/Hack23/lambda-in-private-vpc/actions/workflows/scorecard.yml/badge.svg?branch=main)](https://github.com/Hack23/lambda-in-private-vpc/actions/workflows/scorecard.yml)


## CloudFormation Templates

The project includes several AWS CloudFormation templates that automate the creation and management of the necessary AWS resources:
Expand Down Expand Up @@ -39,18 +37,25 @@

## Architecture Diagrams

- [Infrastructure](cloudformation/template.png) - Depicts the overall infrastructure, including AWS services and components.
- [DNS Route53](cloudformation/route53.png) - Shows the Route 53 configuration for DNS routing and failover.
- [Web Application Firewall](cloudformation/waf.png) - Displays the setup of the Web Application Firewall for securing your application.
- [Disaster Recovery](cloudformation/disaster-recovery.png) - Illustrates the disaster recovery strategy for the application.
- ![Infrastructure](cloudformation/template.png) - Depicts the overall infrastructure, including AWS services and components.
- ![DNS Route53](cloudformation/route53.png) - Shows the Route 53 configuration for DNS routing and failover.
- ![Web Application Firewall](cloudformation/waf.png) - Displays the setup of the Web Application Firewall for securing your application.
- ![Disaster Recovery](cloudformation/disaster-recovery.png) - Illustrates the disaster recovery strategy for the application.

## Resilience Hub Screenshots

- [Resilience Hub Policy](ResilienceHubPolicy.png) - Overview of the policy settings in AWS Resilience Hub.
- [Application](ResiliencyHub-App.png) - The application setup and components in AWS Resilience Hub.
- [App Recommendation 1](ResiliencyHub-App-rec1.png) - First set of recommendations for improving application resiliency.
- [App Recommendation 2](ResiliencyHub-App-rec2.png) - Second set of recommendations for enhancing application resiliency.
- [Region](ResHub-region.png) - Regional recommendations
- ![Resilience Hub Policy](ResilienceHubPolicy.png) - Overview of the policy settings in AWS Resilience Hub.
- ![Application](ResiliencyHub-App.png) - The application setup and components in AWS Resilience Hub.
- ![App Recommendation 1](ResiliencyHub-App-rec1.png) - First set of recommendations for improving application resiliency.
- ![App Recommendation 2](ResiliencyHub-App-rec2.png) - Second set of recommendations for enhancing application resiliency.
- ![Region](ResHub-region.png) - Regional recommendations

## Tech Stack
Hack23/lambda-in-private-vpc is built on the following main stack:

- <img width='25' height='25' src='https://img.stackshare.io/service/11563/actions.png' alt='GitHub Actions'/> [GitHub Actions](https://github.com/features/actions) – Continuous Integration

Full tech stack [here](/techstack.md)

## Relevant Links

Expand All @@ -60,5 +65,20 @@

For more information on AWS service level agreements, visit the [AWS SLA page](https://aws.amazon.com/legal/service-level-agreements/).

## Additional Documentation

- [CHANGELOG.md](CHANGELOG.md)
- [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md)
- [CONTRIBUTING.md](CONTRIBUTING.md)
- [LICENSE.md](LICENSE.md)
- [SECURITY.md](SECURITY.md)
- [AlarmRecommendation-apigateway/alarm/AlarmRecommendation-apigateway-Alarm-172017021075-eu-west-1.json](AlarmRecommendation-apigateway/alarm/AlarmRecommendation-apigateway-Alarm-172017021075-eu-west-1.json)
- [AlarmRecommendation-apigateway/alarm/AlarmRecommendation-apigateway-Alarm-172017021075-eu-west-2.json](AlarmRecommendation-apigateway/alarm/AlarmRecommendation-apigateway-Alarm-172017021075-eu-west-2.json)
- [AlarmRecommendation-apigateway/manifest.json](AlarmRecommendation-apigateway/manifest.json)
- [AlarmRecommendation-apigateway/README.md](AlarmRecommendation-apigateway/README.md)
- [SopRecommendation-apigateway/sop/SopRecommendation-apigateway-Sop-172017021075-eu-west-1.json](SopRecommendation-apigateway/sop/SopRecommendation-apigateway-Sop-172017021075-eu-west-1.json)
- [SopRecommendation-apigateway/manifest.json](SopRecommendation-apigateway/manifest.json)
- [SopRecommendation-apigateway/README.md](SopRecommendation-apigateway/README.md)

## License
This project is licensed under the Apache License 2.0.
Loading