How erpgap/alokai-docker works
Project type and purpose
• This repo is a Docker-based demo that brings up two primary services: a Vue Storefront (VSF) frontend (“Alokai”) and an Odoo 18.0 backend.
• Its goal is to let developers quickly spin up and test a headless VSF storefront integrated with an Odoo ERP instance (not intended for production).
File-structure analysis
• Top-level artifacts:
• .env / .gitignore / README.md / docker-compose.yml
• “18.0/” directory: builds the Odoo 18.0 service (Dockerfile, odoo.conf, Python requirements, startup scripts)
• “alokai/” directory: builds the VSF frontend (its own Dockerfile)
Key README insights
• It specifies two HTTP endpoints: 3000 for the VSF UI, 8069 for Odoo.
• It calls out Redis (used for caching sessions or storefront data).
• It points to three GitHub repos for core storefront modules, Odoo modules, and the Storefront-UI boilerplate.
Main components
a. Frontend service (“Alokai” / Vue Storefront)
b. Backend service (Odoo 18.0 ERP)
c. PostgreSQL database (Odoo data store)
d. Redis cache (session/cache store)
e. Docker Compose network and volumes (to persist DB and modules)
f. External module repositories (SDK-migration branch, alokai-odoo modules, SFUI v2)
Relationships and interactions
• User’s browser → HTTP(S) → VSF frontend (port 3000)
• VSF frontend ↔ HTTP API calls → Odoo backend (port 8069)
• Odoo ↔ SQL protocol → PostgreSQL DB for persistence
• Odoo ↔ Redis protocol → Redis for caching or session storage
• Docker Compose orchestrates the network, volumes, and service lifecycles
Architectural patterns and design principles
• Headless architecture: decoupled frontend (Vue.js) vs. backend (Odoo)
• Micro-service-like separation via containers
• Clear separation of concerns: UI layer, business logic layer, persistence, caching
• Infrastructure as code: Dockerfiles + docker-compose.yml
• Volume mounts for hot-reloading custom modules and config files
Technologies, frameworks, and libraries to annotate
• Vue Storefront (Node.js) and Storefront-UI v2
• Odoo 18.0 (Python, Postgres, custom modules from alokai-odoo)
• Redis (cache)
• PostgreSQL (database)
• Docker & Docker Compose
• Supporting scripts: start_script.py, startup.sh
Diagramming recommendations
• Use clear labels on each container/component (e.g., “VSF Frontend”, “Odoo Backend”, “Postgres DB”, “Redis Cache”)
• Browser → VSF
• VSF → Odoo
• Odoo → Postgres / Redis
• Blue rectangles for application services
• Important ports (3000, 8069, 5432, 6379) and volume mounts (e.g., odoo.conf, custom modules folder)