Compare commits
3 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 30d670a257 | |||
| cfa4d8fa91 | |||
| 39e8d5c9f9 |
@@ -111,6 +111,8 @@ jobs:
|
||||
build-and-push-auth:
|
||||
runs-on: runners-cartsnitch
|
||||
needs: [lint, test]
|
||||
outputs:
|
||||
calver_tag: ${{ steps.calver.outputs.version }}
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
@@ -161,7 +163,7 @@ jobs:
|
||||
|
||||
deploy-dev:
|
||||
runs-on: runners-cartsnitch
|
||||
needs: [build-and-push]
|
||||
needs: [build-and-push, build-and-push-auth]
|
||||
if: github.event_name == 'push' && github.ref == 'refs/heads/main'
|
||||
steps:
|
||||
- name: Generate GitHub App token
|
||||
@@ -191,6 +193,7 @@ jobs:
|
||||
run: |
|
||||
cd infra/apps/overlays/dev
|
||||
kustomize edit set image ghcr.io/cartsnitch/cartsnitch:${{ needs.build-and-push.outputs.calver_tag }}
|
||||
kustomize edit set image ghcr.io/cartsnitch/auth:${{ needs.build-and-push-auth.outputs.calver_tag }}
|
||||
|
||||
- name: Commit and push to infra
|
||||
run: |
|
||||
@@ -198,5 +201,5 @@ jobs:
|
||||
git config user.name "cartsnitch-ci[bot]"
|
||||
git config user.email "cartsnitch-ci[bot]@users.noreply.github.com"
|
||||
git add apps/overlays/dev/kustomization.yaml
|
||||
git commit -m "ci(dev): update cartsnitch image to ${{ needs.build-and-push.outputs.calver_tag }}"
|
||||
git commit -m "ci(dev): update cartsnitch and auth images to ${{ needs.build-and-push.outputs.calver_tag }}"
|
||||
git push origin main
|
||||
|
||||
@@ -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/<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`.
|
||||
# CartSnitch
|
||||
|
||||
Reference in New Issue
Block a user