modified project implementation

Author: KomalSingh21

README.md

@@ -133,7 +133,7 @@ terraform apply → deploy → verify → terraform destroy
 | [`docs/IMPLEMENTATION.md`](docs/implementation.md) | Full build log, phase by phase: local dev → Kind/K8s → CI/CD → monitoring → AWS/Terraform |
 | [`docs/ARCHITECTURE.md`](docs/architecture.md) | Full topology diagram and Architecture Decision Records (ADRs) — the *why* behind each choice |
 | [`docs/TROUBLESHOOTING.md`](docs/troubleshooting.md) | Real incidents hit while building this, in Symptom → Investigation → Root Cause → Fix → Lesson format |
-| [`AWS_IMPLEMENTATION_GUIDE.md`](docs/AWS_IMPLEMENTATION_GUIDE.md) | Full click-by-click Phase 2 walkthrough — account setup through teardown |
+| [`docs/AWS_IMPLEMENTATION_GUIDE.md`](docs/AWS_IMPLEMENTATION_GUIDE.md) | Full click-by-click Phase 2 walkthrough — account setup through teardown |
 | [`app/README.md`](app/README.md) | API endpoints, environment variables, schema, local run instructions |
 
 

docs/configuration.md

@@ -38,35 +38,21 @@ kubectl create secret generic beyondsquare-db \
 
 ---
 
-## 2. Docker Compose (`docker-compose.yaml`)
+## 2. Docker Compose ## 2. Docker Compose
 
-```yaml
-services:
-  api:
-    build: ./app
-    ports: ["3000:3000"]
-    environment:
-      DATABASE_URL: postgres://postgres:postgres@postgres:5432/beyondsquare
-      REDIS_URL: redis://redis:6379
-    depends_on: [postgres, redis]
-  postgres:
-    image: postgres:16-alpine
-    environment:
-      POSTGRES_PASSWORD: postgres
-      POSTGRES_DB: beyondsquare
-    ports: ["5432:5432"]
-    volumes: ["pgdata:/var/lib/postgresql/data"]
-  redis:
-    image: redis:7-alpine
-    ports: ["6379:6379"]
-volumes:
-  pgdata:
-```
+The local application stack is defined in [`docker-compose.yaml`](../docker-compose.yaml).
 
-Note: the top-level `version:` key is intentionally omitted — Docker Compose v2 no longer requires it, and including it now produces an `is obsolete` warning.
+It provides:
 
-`depends_on` only controls **start order**, not readiness — Postgres can still be mid-initialization when the API container starts. 
+- BeyondSquare API
+- PostgreSQL
+- Redis
+- persistent PostgreSQL volume
+- environment-variable based configuration
 
+`depends_on` controls startup order but does not guarantee dependency readiness. The application therefore implements retry-with-backoff during startup.
+
+See [`IMPLEMENTATION.md`](docs/implementation.md) for the execution flow.
 ---
 ## 3. Kubernetes — Kustomize layout
 
@@ -155,8 +141,6 @@ AWS deployment and remains an independently deployable option.
 ---
 ## 5. Terraform variables (`terraform/environments/prod/`) 
 
-## 5. AWS / Terraform configuration
-
 Terraform manages the AWS infrastructure required by Mode 2.
 
 | Variable | Example | Purpose |
@@ -168,23 +152,13 @@ Terraform manages the AWS infrastructure required by Mode 2.
 | `single_nat_gateway` | `true` | Cost-conscious NAT configuration |
 | `domain_name` | optional | Route53/ACM configuration when a domain is available |
 
-Remote state backend (`backend.tf`):
+Terraform uses an S3 backend for remote state.
 
-```hcl
-terraform {
-  backend "s3" {
-    bucket = "beyondsquare-tfstate-<yourname>"
-    key    = "prod/terraform.tfstate"
-    region = "ap-south-1"
-  }
-}
-```
+The backend configuration is defined in:
 
-Create the bucket once, before the first `terraform init`:
+`terraform/environments/prod/backend.tf`
 
-```bash
-aws s3 mb s3://beyondsquare-tfstate-<yourname> --region ap-south-1
-```
+See [`AWS_IMPLEMENTATION_GUIDE.md`](docs/AWS_IMPLEMENTATION_GUIDE.md) for initial backend creation and configuration.
 
 ---
 

docs/implementation.md

@@ -79,24 +79,13 @@ A small REST service (FastAPI/Express-equivalent) exposing:
 - `GET /cache-demo` — first call returns `{"source":"generated"}`, subsequent calls within the cache window return `{"source":"cache"}`, proving Redis is actually in the read path.
 - `GET /metrics` — Prometheus exposition format, via a client library (`prom-client` or equivalent). No code changes are needed later to start scraping it — this is intentional.
 
-### 1.2 Dockerfile — multi-stage, production style
-
-```dockerfile
-FROM node:20-alpine AS builder
-WORKDIR /app
-COPY package*.json ./
-RUN npm ci --only=production
-COPY src ./src
-
-FROM node:20-alpine
-WORKDIR /app
-RUN addgroup -S app && adduser -S app -G app
-COPY --from=builder /app /app
-USER app
-EXPOSE 3000
-HEALTHCHECK CMD wget -qO- http://localhost:3000/health || exit 1
-CMD ["node", "src/index.js"]
-```
+### 1.2 Container image
+
+The API is containerized using the Dockerfile in `app/Dockerfile`.
+
+The image uses a multi-stage build and runs the application as a non-root user.
+
+See [`app/Dockerfile`](../app/Dockerfile) for the current implementation.
 
 Multi-stage build → smaller final image (no build toolchain shipped). Non-root `USER app` → a security best practice worth naming explicitly in an interview.