This repository has been archived on 2026-02-24. You can view files and clone it. You cannot open issues or pull requests or push a commit.
Files
cart/README.md
giles fb70c4c76d
Some checks failed
Build and Deploy / build-and-deploy (push) Has been cancelled
README: replace vague cross-app section with actual code dependencies
List specific model imports, glue services, internal APIs, and
domain events that cart code actually references.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-14 19:47:55 +00:00

98 lines
3.7 KiB
Markdown

# Cart App
Shopping cart, checkout, and order management service for the Rose Ash cooperative.
## Architecture
One of four Quart microservices sharing a single PostgreSQL database:
| App | Port | Domain |
|-----|------|--------|
| blog (coop) | 8000 | Auth, blog, admin, menus, snippets |
| market | 8001 | Product browsing, Suma scraping |
| **cart** | 8002 | Shopping cart, checkout, orders |
| events | 8003 | Calendars, bookings, tickets |
## Structure
```
app.py # Application factory (create_base_app + blueprints)
path_setup.py # Adds project root + app dir to sys.path
config/app-config.yaml # App URLs, SumUp config
models/ # Cart-domain models
order.py # Order, OrderItem
page_config.py # PageConfig (per-page SumUp credentials)
bp/
cart/ # Cart blueprint
global_routes.py # Add to cart, checkout, webhooks, return page
page_routes.py # Page-scoped cart and checkout
overview_routes.py # Cart overview / summary page
api.py # Internal API (/internal/cart/summary)
services/ # Business logic
checkout.py # Order creation, SumUp integration
check_sumup_status.py # Payment status polling
calendar_cart.py # Calendar entry cart queries
page_cart.py # Page-scoped cart queries
get_cart.py # Cart item queries
identity.py # Cart identity (user_id / session_id)
total.py # Price calculations
clear_cart_for_order.py # Soft-delete cart after checkout
order/ # Single order detail view
orders/ # Order listing view
templates/ # Jinja2 templates
entrypoint.sh # Docker entrypoint
Dockerfile
shared/ # Submodule → git.rose-ash.com/coop/shared.git
glue/ # Submodule → git.rose-ash.com/coop/glue.git
```
## Dependencies
**Cross-app model imports:**
- `market.models.market.Product, CartItem` — cart services, checkout, API
- `market.models.market_place.MarketPlace` — checkout page-config resolution, API page filtering
- `events.models.calendars.CalendarEntry, Calendar` — checkout, API summary, calendar cart services
- `blog.models.ghost_content.Post``app.py` context processor, API page-slug lookup
**Glue services:**
- `glue.services.order_lifecycle.claim_entries_for_order` — checkout marks entries as "ordered"
- `glue.services.order_lifecycle.confirm_entries_for_order` — payment confirmation marks entries "provisional"
- `glue.services.order_lifecycle.get_entries_for_order` — checkout return page loads entries
- `glue.services.navigation.get_navigation_tree` — context processor builds site nav
**Internal APIs:**
- Exposes `GET /internal/cart/summary` — cart count + total for current session/user
**Domain events:**
- `checkout.py` emits `order.created` via `shared.events.emit_event`
- `check_sumup_status.py` emits `order.paid` via `shared.events.emit_event`
## Checkout Flow
```
1. User clicks "Checkout"
2. create_order_from_cart() creates Order + OrderItems
3. glue: claim_entries_for_order() marks CalendarEntries as "ordered"
4. emit: order.created event
5. SumUp hosted checkout created, user redirected
6. SumUp webhook / return page triggers check_sumup_status()
7. If PAID: glue: confirm_entries_for_order(), emit: order.paid
```
## Running
```bash
export DATABASE_URL_ASYNC=postgresql+asyncpg://user:pass@localhost/coop
export REDIS_URL=redis://localhost:6379/0
export SECRET_KEY=your-secret-key
hypercorn app:app --reload --bind 0.0.0.0:8002
```
## Docker
```bash
docker build -t cart .
docker run -p 8002:8000 --env-file .env cart
```