Update app READMEs for monorepo
All checks were successful
Build and Deploy / build-and-deploy (push) Successful in 2m56s
All checks were successful
Build and Deploy / build-and-deploy (push) Successful in 2m56s
Remove stale submodule references, port numbers, and Running sections. Add fragment composition details. Create READMEs for federation and account. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -2,41 +2,33 @@
|
||||
|
||||
Product browsing and marketplace service for the Rose Ash cooperative. Displays products scraped from Suma Wholesale.
|
||||
|
||||
## Architecture
|
||||
|
||||
One of five 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 |
|
||||
| federation | 8004 | ActivityPub, fediverse social |
|
||||
|
||||
## 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, feature flags
|
||||
models/ # Market-domain models (+ re-export stubs)
|
||||
bp/ # Blueprints
|
||||
entrypoint.sh # Container entrypoint (Redis flush, start)
|
||||
bp/
|
||||
market/ # Market root, navigation, category listing
|
||||
browse/ # Product browsing with filters and infinite scroll
|
||||
product/ # Product detail pages
|
||||
cart/ # Page-scoped cart views
|
||||
api/ # Product sync API (used by scraper)
|
||||
fragments/ # container-nav fragment (market links)
|
||||
scrape/ # Suma Wholesale scraper
|
||||
models/ # Re-export stubs pointing to shared/models/
|
||||
services/ # register_domain_services() — wires market + cart
|
||||
shared/ # Submodule -> git.rose-ash.com/coop/shared.git
|
||||
templates/ # Market-specific templates (override shared/)
|
||||
```
|
||||
|
||||
## Cross-Domain Communication
|
||||
## Cross-domain communication
|
||||
|
||||
- `services.cart.*` — cart summary via CartService protocol
|
||||
- `services.federation.*` — AP publishing via FederationService protocol
|
||||
- `shared.services.navigation` — site navigation tree
|
||||
|
||||
## Fragments served
|
||||
|
||||
- **container-nav** — market navigation links for blog sidebar
|
||||
|
||||
## Scraping
|
||||
|
||||
@@ -44,13 +36,3 @@ shared/ # Submodule -> git.rose-ash.com/coop/shared.git
|
||||
bash scrape.sh # Full Suma Wholesale catalogue
|
||||
bash scrape-test.sh # Limited test scrape
|
||||
```
|
||||
|
||||
## 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 --bind 0.0.0.0:8001
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user