Skip to content

Commit 55fa4ad

Browse files
authored
Update README.md
1 parent 6eaf90f commit 55fa4ad

1 file changed

Lines changed: 4 additions & 1 deletion

File tree

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ This project is built using modern and scalable technologies to ensure high perf
4545
- **🐘 Database:** [PostgreSQL](https://www.postgresql.org/) – A powerful, production-grade relational database system used for persistent URL storage.
4646
- **🐳 Containerization:** [Docker](https://www.docker.com/) & [Docker Compose](https://docs.docker.com/compose/) – For building, packaging, and running the app in isolated environments, ensuring platform consistency.
4747
- **⚙️ CI/CD Automation:** [GitHub Actions](https://github.com/features/actions) – Automated build, test, and deployment pipeline triggered on code push to `main`.
48-
- **☁️ Deployment Target:** [AWS EC2 (Ubuntu 22.04)](https://aws.amazon.com/ec2/) – Cloud infrastructure hosting the application, with port `8000` publicly exposed for API access.
48+
- **☁️ Deployment Target:** [AWS EC2 (Ubuntu 22.04)](https://aws.amazon.com/ec2/) – Cloud infrastructure hosting the application, with port `8001` publicly exposed for API access.
4949
- **🔐 Secure Access:** SSH key-based authentication ensures safe and authorized deployments to the cloud server.
5050
- **📦 Package Management:** `pip` with a clean `requirements.txt` for dependency management.
5151

@@ -70,6 +70,8 @@ If deployed in a public environment, consider adding access control or usage lim
7070

7171
## 📡 API Endpoints
7272

73+
You can use tools like Swagger UI or Postman to test these endpoints interactively.
74+
7375
| Method | Route | Description |
7476
|--------|---------------|-------------------------------|
7577
| POST | `/shorten` | Shorten a long URL |
@@ -128,3 +130,4 @@ Even though the service is production-ready, the current version includes the fo
128130

129131
This project is licensed under the [MIT License](LICENSE).
130132

133+

0 commit comments

Comments
 (0)