Merge develop into main

[ForeverProglamer]

Summary by CodeRabbit

• Documentation

  • Updated README with deployment environments, architecture overview, business flow, and expanded quick start guide with API usage examples.
  • Added comprehensive CI/CD documentation covering workflows and deployment process.

• Infrastructure

  • Restricted API service port binding to localhost for improved security.

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7bbc04f1-a99c-4d48-a188-694c24040e96

📥 Commits

Reviewing files that changed from the base of the PR and between d810049 and b5f974c.

📒 Files selected for processing (3)

• README.md
• compose.prod.yml
• docs/task-9-ci-cd.md

---

📝 Walkthrough

Walkthrough

Enhanced README with relocated CI/CD documentation and API usage examples. Created new detailed CI/CD workflow documentation describing GitHub Actions pipelines and production deployment flow. Modified production Docker Compose to bind API service to loopback interface only.

Changes

Documentation Refactor

Layer / File(s)	Summary
New CI/CD Documentation docs/task-9-ci-cd.md	Complete CI/CD workflow guide documenting pr-checks.yml, build-and-stage.yml, and deploy-prod.yml with GHCR image tagging, release-manifest.json generation, and deployment to Oracle Cloud VM via Docker Compose.
README Restructuring & Linking README.md	README reorganized with "Deployed Environments", "Main Business Flow", "Architecture", expanded "Local Quick Start" (with Swagger/health URLs), and "API Usage" example flow. CI/CD section condensed with link to docs/task-9-ci-cd.md. Added "Additional Documentation" task index.

Production Binding Security

Layer / File(s)	Summary
Port Binding Configuration compose.prod.yml	API service port binding changed from ${API_PORT}:3000 (all interfaces) to 127.0.0.1:${API_PORT}:3000 (loopback-only).

Estimated Code Review Effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

🐰 Docs now dance in folders neat,
Security binds to loopback's beat,
CI workflows laid out plain,
Deployments flow through GitHub's vein,
All changes hop with purpose bright! 🎉

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch develop

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}