From 189d03736d4c73e5038fbc7b8dfc32e2f25aa737 Mon Sep 17 00:00:00 2001 From: "cpfarhood-k8s[bot]" <269718141+cpfarhood-k8s[bot]@users.noreply.github.com> Date: Mon, 30 Mar 2026 00:50:51 +0000 Subject: [PATCH] test --- README.md | 46 +--------------------------------------------- 1 file changed, 1 insertion(+), 45 deletions(-) diff --git a/README.md b/README.md index 6b626cf..aa49629 100644 --- a/README.md +++ b/README.md @@ -1,45 +1 @@ -# 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/` or `fix/` -- 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`. +# CartSnitch