a29612ffa4
All checks were successful
Build and Deploy / build-and-deploy (push) Successful in 55s
Fix microservice count (4 not 3), document submodules, models, scraper, all blueprints including bp/cart/, and cross-app integration. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
80 lines
2.6 KiB
Markdown
80 lines
2.6 KiB
Markdown
# Market App
|
|
|
|
Product browsing and marketplace service for the Rose Ash cooperative. Displays products scraped from Suma Wholesale.
|
|
|
|
## 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, feature flags
|
|
models/ # Market-domain models
|
|
market.py # Product, Category, CartItem
|
|
market_place.py # MarketPlace (page-scoped marketplace)
|
|
bp/ # Blueprints
|
|
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)
|
|
scrape/ # Suma Wholesale scraper
|
|
get_auth.py # Authentication
|
|
listings.py # Product listing pages
|
|
nav.py # Category navigation
|
|
product/ # Individual product scraping
|
|
build_snapshot/ # Build product snapshots
|
|
persist_snapshot/ # Save snapshots to DB
|
|
persist_api/ # Save via API
|
|
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
|
|
```
|
|
|
|
## Cross-App Integration
|
|
|
|
- **Cart:** "Add to cart" posts to cart app. Cart widget fetched via internal API.
|
|
- **Blog:** Post/page data fetched via internal API for page-scoped marketplaces.
|
|
- **Glue:** MarketPlace uses generic containers (`container_type + container_id`) to attach to pages without FK coupling.
|
|
|
|
## Scraping
|
|
|
|
```bash
|
|
# Full scrape (Suma Wholesale catalogue)
|
|
bash scrape.sh
|
|
|
|
# Test scraping (limited)
|
|
bash scrape-test.sh
|
|
```
|
|
|
|
## 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
|
|
export SUMA_USER=your-suma-username
|
|
export SUMA_PASSWORD=your-suma-password
|
|
|
|
hypercorn app:app --reload --bind 0.0.0.0:8001
|
|
```
|
|
|
|
## Docker
|
|
|
|
```bash
|
|
docker build -t market .
|
|
docker run -p 8001:8000 --env-file .env market
|
|
```
|