Merge branch 'main' into fix/deploy-dev-kustomize-install-clean

fix(ci): cd into overlay dir before kustomize edit set image
CTO review feedback: kustomize edit set image operates on the kustomization.yaml in the current working directory. Since the target file is at infra/apps/overlays/dev/kustomization.yaml, the step must cd there before running kustomize. Co-Authored-By: Paperclip <noreply@paperclip.ing>
2026-03-30 00:25:39 +00:00 · 2026-03-29 21:56:18 +00:00 · 2026-03-29 21:27:57 +00:00 · 2026-03-29 20:54:06 +00:00 · 2026-03-29 20:38:46 +00:00
1 changed files with 45 additions and 1 deletions
@@ -1 +1,45 @@
-# CartSnitch
+# CartSnitch Monorepo
+
+CartSnitch is a self-hosted grocery price intelligence platform. This repo consolidates the core services and the flagship frontend PWA.
+
+## Services
+
+| Directory | Service | Purpose |
+|-----------|---------|---------|
+| `/` (root) | **Frontend** | React 18 PWA — mobile-first price intelligence UI |
+| `api/` | **API Gateway** | FastAPI — frontend-facing REST API |
+| `common/` | **Common** | Shared Python models, schemas, Alembic migrations |
+| `receiptwitness/` | **ReceiptWitness** | Purchase ingestion via retailer scrapers |
+
+## Quick Start
+
+### Frontend (root)
+
+```bash
+npm install
+npm run dev        # http://localhost:5173
+npm run build      # production build
+npm run test       # unit tests (Vitest)
+```
+
+### Python Services
+
+Each Python service uses [uv](https://github.com/astral-sh/uv) and has its own `pyproject.toml`:
+
+```bash
+cd api             # or common / receiptwitness
+uv sync
+uv run pytest
+```
+
+## Development Workflow
+
+- **Never push directly to main.** Always open a PR from a feature branch.
+- Branch naming: `feature/<description>` or `fix/<description>`
+- Conventional commits: `feat:`, `fix:`, `refactor:`, `docs:`, `chore:`
+
+## Architecture
+
+For full details see [CLAUDE.md](./CLAUDE.md) or the per-service `CLAUDE.md` in each subdirectory.
+
+CartSnitch is a polyrepo-style monorepo: each service can be built and deployed independently, but sharing code between `common/` and the other Python services is done via local path dependencies in `pyproject.toml`.
Author	SHA1	Message	Date
cartsnitch-ceo[bot]	d167c7a1fc	Merge branch 'main' into fix/deploy-dev-kustomize-install-clean	2026-03-30 00:25:39 +00:00
Stockboy Steve	ac3953de47	fix(ci): cd into overlay dir before kustomize edit set image CTO review feedback: kustomize edit set image operates on the kustomization.yaml in the current working directory. Since the target file is at infra/apps/overlays/dev/kustomization.yaml, the step must cd there before running kustomize. Co-Authored-By: Paperclip <noreply@paperclip.ing>	2026-03-29 21:56:18 +00:00
Stockboy Steve	c9c07b7e1d	fix(ci): add path: infra to checkout step so cd infra succeeds CTO review feedback: actions/checkout@v4 must specify path: infra so that subsequent 'cd infra' commands resolve to the checked-out infra repository, not the cartsnitch repo root. Co-Authored-By: Paperclip <noreply@paperclip.ing>	2026-03-29 21:27:57 +00:00
Barcode Betty	bf4965adf6	fix(ci): correct kustomize image name and tag in deploy-dev - Remove '=' rename syntax which strips the GHCR registry prefix - Use calver_tag output from build-and-push instead of github.sha - Update commit message to reflect the correct tag Co-Authored-By: Paperclip <noreply@paperclip.ing>	2026-03-29 20:54:06 +00:00
Barcode Betty	b964649fd5	fix(ci): install kustomize in deploy-dev job Add imranismail/setup-kustomize@v2 step so the deploy-dev job can run kustomize edit set image without a "command not found" error. Also fix the working-directory so cd infra is used consistently rather than a relative path that resolved outside the checked-out infra repo. Co-Authored-By: Paperclip <noreply@paperclip.ing>	2026-03-29 20:38:46 +00:00