How john-6670/e-commerce-api works
Project Type and Purpose
• This is a monolithic Django‑based Web API for an e‑commerce platform (no bundled frontend, only backend/API).
• Purpose: expose REST endpoints for user authentication (with JWT), product management, order processing, email verification and password‑reset flows, plus an admin UI and interactive API docs.
File Structure
• Top‑level files:
• manage.py – Django’s CLI entry point
• config/ – project settings (settings.py), URL routing (urls.py), ASGI/WSGI servers
• requirements.txt – pinned dependencies
• Apps (each under its own folder):
• accounts/ – custom user model, authentication, email verification, JWT, permissions, serializers, views, URLs
• products/ – models, serializers, views, URL routing, product‑related utilities
• orders/ – order models, serializers, views, URL routing, signal handlers (automatic cart creation)
• Configured for PostgreSQL, JWT auth, Swagger/ReDoc, console email backend (development).
README for Architectural Insights
• Key stacks: Django, Django REST Framework (DRF), PostgreSQL, JWT, Swagger/ReDoc, console or SMTP email backend.
• Flows described: register→verify→login, forgot‑password→reset.
• No explicit microservices—this is a single Django monolith with distinct “apps.”
Core Components and Relationships
a. External Clients
• Web or mobile frontend (not in repo)
• Admin user via Django Admin UI
• Swagger/ReDoc UI (auto‑generated docs)
b. API Layer (Django + DRF)
• URL dispatcher (config/urls.py) routes to app views
• Authentication middleware (JWT) sits on every request
c. Business Logic Apps
• Accounts app (registration, login, email, permissions)
• Products app (CRUD, stock, reviews)
• Orders app (cart management, order status)
d. Database
• PostgreSQL storing users, products, orders, migrations under each app
e. External Services
• SMTP (or console) Email Backend for verification & password resets
Architectural Patterns & Design Principles
• Monolithic, modularized by Django “apps” (logical separation of concerns).
• DRF serializers & viewsets isolate API contract from models.
• Signal handlers (orders/signals.py) implement event‑driven logic (cart creation).
• Custom permissions (accounts/permissions.py) enforce RBAC.
• Environment‑based configuration (config/settings.py + .env).