docs: add consolidated dev URL reference and migrate /shop to /storefront
Some checks failed
Some checks failed
- Add Development URL Quick Reference section to url-routing overview with all login URLs, entry points, and full examples - Replace /shop/ path segments with /storefront/ across 50 docs files - Update file references: shop_pages.py → storefront_pages.py, templates/shop/ → templates/storefront/, api/v1/shop/ → api/v1/storefront/ - Preserve domain references (orion.shop) and /store/ staff dashboard paths - Archive docs left unchanged (historical) Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -7,7 +7,7 @@ Complete guide to the authentication and authorization system powering the multi
|
||||
The platform uses a JWT-based authentication system combined with role-based access control (RBAC) to secure all interfaces:
|
||||
- **Admin** interface
|
||||
- **Store** dashboard
|
||||
- **Shop** storefront
|
||||
- **Storefront**
|
||||
- **REST API** endpoints
|
||||
|
||||
## Authentication System
|
||||
@@ -60,17 +60,17 @@ User.role: "super_admin" | "platform_admin" | "merchant_owner" | "store_member"
|
||||
|
||||
### Customer Role (Separate Model)
|
||||
|
||||
**Access**: Public shop and own account space
|
||||
**Access**: Public storefront and own account space
|
||||
|
||||
**Capabilities**:
|
||||
- Browse store shops
|
||||
- Browse store storefronts
|
||||
- Place orders
|
||||
- Manage their own account and order history
|
||||
- View order status
|
||||
- Update profile information
|
||||
- Can register directly from shop frontend
|
||||
- Can register directly from storefront frontend
|
||||
|
||||
**Account Creation**: Self-registration via shop frontend (email verification required)
|
||||
**Account Creation**: Self-registration via storefront frontend (email verification required)
|
||||
|
||||
**Authentication**: Standard JWT authentication (separate `Customer` model, not `User`)
|
||||
|
||||
@@ -89,7 +89,7 @@ User.role: "super_admin" | "platform_admin" | "merchant_owner" | "store_member"
|
||||
- Manage products and inventory
|
||||
- Process orders
|
||||
- View analytics and reports
|
||||
- Configure shop settings
|
||||
- Configure storefront settings
|
||||
- Manage team members (invite, remove, update roles)
|
||||
- Access store-specific APIs
|
||||
|
||||
@@ -155,8 +155,8 @@ The platform has three distinct areas with different access requirements:
|
||||
| Area | URL Pattern | Access | Purpose |
|
||||
|------|-------------|--------|---------|
|
||||
| **Admin** | `/admin/*` or `admin.platform.com` | Super admins and platform admins (`is_admin`) | Platform administration and store management |
|
||||
| **Store** | `/store/*` | Merchant owners and store members (`is_store_user`) | Store dashboard and shop management |
|
||||
| **Shop** | `/shop/*`, custom domains, subdomains | Customers and public | Public-facing eCommerce storefront |
|
||||
| **Store** | `/store/*` | Merchant owners and store members (`is_store_user`) | Store dashboard and storefront management |
|
||||
| **Storefront** | `/storefront/*`, custom domains, subdomains | Customers and public | Public-facing eCommerce storefront |
|
||||
| **API** | `/api/*` | All authenticated users (role-based) | REST API for all operations |
|
||||
|
||||
## Account Registration Flow
|
||||
@@ -174,7 +174,7 @@ The platform has three distinct areas with different access requirements:
|
||||
- Activation: Upon clicking email verification link
|
||||
|
||||
### Customer Accounts
|
||||
- ✅ Can register directly on store shop
|
||||
- ✅ Can register directly on store storefront
|
||||
- Activation: Upon clicking registration email link
|
||||
- Used for: Shopping and order management
|
||||
|
||||
@@ -222,8 +222,8 @@ Allows access to customer users and admins.
|
||||
|
||||
**Usage**:
|
||||
```python
|
||||
@app.get("/shop/orders")
|
||||
async def customer_orders(
|
||||
@app.get("/storefront/orders")
|
||||
async def storefront_orders(
|
||||
current_user: User = Depends(auth_manager.require_customer)
|
||||
):
|
||||
return {"orders": [...]}
|
||||
@@ -390,13 +390,13 @@ graph TD
|
||||
|
||||
D[Merchant Owner<br/>role=merchant_owner] --> E[Store Dashboard]
|
||||
D --> F[Team Management]
|
||||
D --> G[Shop Settings]
|
||||
D --> G[Storefront Settings]
|
||||
D --> H[All Store Permissions - 75]
|
||||
|
||||
I[Store Member<br/>role=store_member] --> E
|
||||
I --> J[Role-Based Permissions]
|
||||
|
||||
K[Customer<br/>separate model] --> L[Shop Access]
|
||||
K[Customer<br/>separate model] --> L[Storefront Access]
|
||||
K --> M[Own Orders]
|
||||
K --> N[Own Profile]
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user