Skip to content

Commit 7de8bdf

Browse files
committed
refine readme
1 parent 39829ef commit 7de8bdf

2 files changed

Lines changed: 9 additions & 21 deletions

File tree

README.md

Lines changed: 9 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,16 @@
11
# AWS AScan Todo Application
22

3-
A serverless todo application built using AWS Lambda, API Gateway, and DynamoDB.
3+
A serverless todo application built using AWS Lambda, IAM and DynamoDB.
4+
5+
![alt text](assets/image.png)
46

57
## Overview
68

7-
This project implements a serverless todo application that allows users to create, read, update, and delete todo items. The application is containerized and deployed on AWS Lambda, with DynamoDB as the database backend.
9+
This project implements a serverless todo API that allows users to create, read, update, and delete todo items. The application is containerized and deployed on AWS Lambda, with DynamoDB as the database backend.
810

911
## Architecture
1012

1113
The application follows a serverless architecture with the following components:
12-
13-
<!-- - **Frontend**: Web interface for interacting with the todo application -->
14-
<!-- - **API Gateway**: RESTful API endpoints to manage todo items -->
1514
- **AWS Lambda**: Serverless functions to process API requests
1615
- **DynamoDB**: NoSQL database to store todo items
1716
- **Amazon ECR**: Container registry to store the application Docker image
@@ -76,9 +75,8 @@ The application provides the following API endpoints:
7675
POST /todos
7776
{
7877
"title": "Complete documentation",
79-
"description": "Finish the README.md file",
80-
"dueDate": "2023-06-30",
81-
"completed": false
78+
"done": false,
79+
"priority": 1,
8280
}
8381
```
8482

@@ -87,10 +85,8 @@ POST /todos
8785
{
8886
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
8987
"title": "Complete documentation",
90-
"description": "Finish the README.md file",
91-
"dueDate": "2023-06-30",
92-
"completed": false,
93-
"createdAt": "2023-06-20T12:00:00Z"
88+
"done": false,
89+
"priority": 2,
9490
}
9591
```
9692

@@ -108,12 +104,4 @@ Common issues and their solutions:
108104
- **API returns 5xx errors**: Check Lambda logs in CloudWatch
109105
- **Container fails to start**: Verify environment variables are properly set
110106
- **CI pipeline fails**: Ensure AWS credentials are properly configured in GitHub secrets
111-
- **Infrastructure deployment fails**: Check the workflow logs in the `infra-aws-ascan` repository
112-
113-
## Contributors
114-
115-
- Your development team
116-
117-
## License
118-
119-
[Insert license information]
107+
- **Infrastructure deployment fails**: Check the workflow logs in the `infra-aws-ascan` repository

assets/image.png

122 KB
Loading

0 commit comments

Comments
 (0)