Skip to content

Commit da97d79

Browse files
committed
Upate README.md wihtout toc
1 parent 63388d6 commit da97d79

File tree

1 file changed

+9
-24
lines changed

1 file changed

+9
-24
lines changed

README.md

Lines changed: 9 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,23 @@
1-
# aws-cdk-ecs-api
2-
3-
- [aws-cdk-ecs-api](#aws-cdk-ecs-api)
4-
- [Overview](#overview)
5-
- [AWS Architecture Diagram](#aws-architecture-diagram)
6-
- [Folders Explained](#folders-explained)
7-
- [Usage](#usage)
8-
- [Clone the repository](#clone-the-repository)
9-
- [Configure Python](#configure-python)
10-
- [Configure CDK](#configure-cdk)
11-
- [Dependencies](#dependencies)
12-
- [Software](#software)
13-
- [Tools](#tools)
14-
- [Special thanks](#special-thanks)
15-
- [Author](#author)
16-
- [LICENSE](#license)
17-
18-
## Overview
1+
# :trident: AWS-CDK-ECS-API :trident:
192

203
AWS FastAPI CDK deployment on top of ALB and ECS with Docker containers implementing ECS as the orchestration tool for an AWS-managed infrastructure.
214

5+
## Summary/Overview :memo:
6+
227
- Deployed on AWS with Infrastructure as Code on [CDK-Python](https://aws.amazon.com/cdk/).
238
- API developed with [FastAPI](https://fastapi.tiangolo.com/lo/).
249
- Unit and Integration Tests for the source code with [PyTest](https://docs.pytest.org/en/latest).
2510
- Containerized solution with [Docker](https://www.docker.com) orchestrated by [Amazon ECS](https://aws.amazon.com/ecs/) (Fargate).
2611
- Load Balancing managed with [ELB - Application Load Balancer](https://docs.aws.amazon.com/elasticloadbalancing/latest/application/introduction.html) with listener ECS Service as target group.
2712
- Public DNS records on top of [Route 53](https://aws.amazon.com/route53/) with Certificates on [AWS Certificate Manager](https://aws.amazon.com/certificate-manager/).
2813

29-
## AWS Architecture Diagram
14+
## AWS Architecture Diagram :trophy:
3015

3116
The AWS infrastructure solution is deployed with CDK-Python with the resources defined on the `cdk` folder:
3217

3318
<img src="assets/aws-cdk-ecs-api-architecture.png" width=80%> <br>
3419

35-
## Folders Explained
20+
## Folders Explained :scroll:
3621

3722
This repository consists of multiple folders/files, which are explained as follows:
3823

@@ -41,7 +26,7 @@ This repository consists of multiple folders/files, which are explained as follo
4126
- Tests ([`./tests/`](./tests/))
4227
- Docker containerization ([`./src/Dockerfile`](./src/Dockerfile)).
4328

44-
## Usage
29+
## Usage :white_check_mark:
4530

4631
Follow these steps to configure the project locally:
4732

@@ -70,7 +55,7 @@ Review the step by step commands for configuring the CDK at:
7055

7156
> Note: for deploying or destroying the solution, see ("part 3") inside [`./commands_cdk.sh`](./commands_cdk.sh).
7257
73-
## Dependencies
58+
## Dependencies :100:
7459

7560
### Software
7661

@@ -91,11 +76,11 @@ Review the step by step commands for configuring the CDK at:
9176
- [AWS CLI](https://aws.amazon.com/cli/) <br>
9277
The AWS Command Line Interface (AWS CLI) is a unified tool to manage your AWS services. We will use it for connecting to our AWS account from the terminal (authentication and authorization towards AWS). <br>
9378

94-
## Special thanks
79+
## Special thanks :beers:
9580

9681
- I am grateful to the talented individuals who have dedicated their time and effort to develop the exceptional open-source projects that have been used in the creation of this solution. <br>
9782

98-
## Author
83+
## Author :musical_keyboard:
9984

10085
**Santiago Garcia Arango**
10186

0 commit comments

Comments
 (0)