🚀 ECO_FLOW_Odoo - Product Lifecycle Management System

A comprehensive Engineering Change Order (ECO) & Version Master Data Management system built with modern technologies for manufacturing and product development teams.

---

📋 Table of Contents

• Overview
• Key Features
• Architecture
• System Workflow
• Technology Stack
• Project Structure
• Getting Started
• User Roles & Permissions
• Database Schema
• API Endpoints
• Contributing
• License

---

🎯 Overview

ECO_FLOW_Odoo is a PLM (Product Lifecycle Management) tool that manages changes to Products and Bills of Materials (BoMs) through a controlled workflow. It enforces a strict Propose → Approve → Apply process to prevent direct edits to master data.

Core Problem Solved

• ❌ No direct edits to master product data
• ✅ Centralized change management
• ✅ Complete audit trails
• ✅ Role-based access control
• ✅ Version control with versioning

---

✨ Key Features

Feature	Description
🔒 Role-Based Access Control	Engineering, Approver, Operations, Admin roles with granular permissions
📝 ECO Workflow Management	Propose → Review → Approve → Apply with state machine
📦 Product Versioning	Automatic version management with active/archived states
🧪 Bill of Materials (BoM)	Hierarchical BoM structure with component validation
👁️ Diff Visualization	Side-by-side comparison with color-coded changes
📊 Audit Trail	Complete history of all changes with timestamps
🔄 Redis Caching	Fast session management and active master data caching
🐳 Docker Deployment	Containerized backend and frontend with Docker Compose

---

🏗️ Architecture

High-Level System Architecture

┌─────────────────────────────────────────────────────────────┐
│                     CLIENT LAYER                             │
│  ┌──────────────────────────────────────────────────────┐   │
│  │  React Frontend (Vite + Tailwind CSS + React Router) │   │
│  │  • Product Dashboard  • BoM Editor                   │   │
│  │  • ECO Management    • Diff Visualization            │   │
│  └──────────────────────────────────────────────────────┘   │
└─────────────────────────────────────────────────────────────┘
                              ↑
                    HTTP/REST API (JSON)
                              ↓
┌─────────────────────────────────────────────────────────────┐
│                   APPLICATION LAYER                          │
│  ┌──────────────────────────────────────────────────────┐   │
│  │       Go Backend (Gin Framework + JWT Auth)          │   │
│  │  • API Handlers    • Services    • Middleware        │   │
│  │  • ECO Engine      • Validation  • Authorization     │   │
│  └──────────────────────────────────────────────────────┘   │
└─────────────────────────────────────────────────────────────┘
                              ↑
                    Database Connections
                              ↓
┌──────────────────────────────────────────────────────────────┐
│                   DATA LAYER                                 │
│  ┌────────────────────────┐  ┌──────────────────────────┐   │
│  │   PostgreSQL DB        │  │   Redis Cache/PubSub     │   │
│  │  • Products            │  │  • Sessions              │   │
│  │  • BoMs                │  │  • Active Master Data    │   │
│  │  • ECOs                │  │  • User Permissions      │   │
│  │  • Audit Logs          │  │  • Temp Storage          │   │
│  └────────────────────────┘  └──────────────────────────┘   │
└──────────────────────────────────────────────────────────────┘

---

🔄 System Workflow

ECO (Engineering Change Order) Process

┌──────────────┐
│   NEW ECO    │  User creates ECO (Draft Product/BoM clone)
└──────┬───────┘
       │
       ↓
┌──────────────────────────────────────┐
│  USER EDITS DRAFT                    │  
│  (Master data untouched)             │
│  • Modify Product Details            │
│  • Update BoM Components             │
│  • Attach Files                      │
└──────┬───────────────────────────────┘
       │
       ↓
┌──────────────────────────────────────┐
│  SUBMIT FOR REVIEW                   │
│  ECO Status: IN REVIEW               │
│  (Approvers notified)                │
└──────┬───────────────────────────────┘
       │
       ├─────────────────────────────────┐
       │                                 │
       ↓                                 ↓
   ┌─────────┐                    ┌──────────┐
   │ APPROVED │                    │ REJECTED │
   └────┬────┘                    └──────┬───┘
        │                               │
        │ (Return to DRAFT)             │
        │ for re-edit ←─────────────────┘
        │
        ↓
   ┌─────────────────────────────────────┐
   │  APPLY TO PRODUCTION                │
   │  *** Transaction ***                │
   │  • Archive old version              │
   │  • Activate new version             │
   │  • Log to Audit Trail               │
   │  • Notify Oper ations                │
   └──────┬────────────────────────────┘
          │
          ↓
   ┌──────────────────┐
   │  APPLIED & LIVE  │
   │  (Available to   │
   │   Operations)    │
   └──────────────────┘

Data Flow: Product Lifecycle

┌────────────────────────────────────────────────────────────┐
│                    MASTER DATA STATE                        │
└────────────────────────────────────────────────────────────┘

INITIAL STATE:
  Product v1 (ACTIVE) → Used by Operations
       ↓
       Approver sees active version in read-only

ECO CREATED:
  Product v1 (ACTIVE) ──┐
                        ├→ ECO clones v1 → v1-DRAFT
  Approver creates      │
                        └→ Engineering edits v1-DRAFT

ECO APPROVED & APPLIED:
  Product v1 (ARCHIVED) ← Old version archived
  Product v2 (ACTIVE)   ← New version activated
       ↓
       Operations now fetch v2 automatically

---

💻 Technology Stack

Backend

• Language: Go (Golang)
• Framework: Gin Web Framework
• Authentication: JWT (JSON Web Tokens)
• Database: PostgreSQL 12+
• Caching: Redis
• Validation: Custom middleware & service layer

Frontend

• Framework: React 18+ (with Vite bundler)
• Styling: Tailwind CSS 3+
• Routing: React Router v6
• State Management: React Context API
• HTTP Client: Axios/Fetch API
• UI Components: Custom + Tailwind

Infrastructure

• Containerization: Docker
• Orchestration: Docker Compose
• Reverse Proxy: Nginx
• Environment: Linux containers

DevOps & Tools

• Version Control: Git
• Database Migrations: SQL scripts
• Environment Configuration: .env files

---

📁 Project Structure

ECO_FLOW_Odoo/
├── backend/                          # Go backend API
│   ├── cmd/
│   │   ├── api/                      # API server entrypoint
│   │   │   └── main.go
│   │   └── migrate/                  # Database migration tool
│   │       └── main.go
│   ├── internal/
│   │   ├── config/                   # Configuration management
│   │   │   └── config.go
│   │   ├── database/                 # DB & Redis connection
│   │   │   ├── database.go
│   │   │   └── redis.go
│   │   ├── handlers/                 # HTTP request handlers
│   │   │   ├── auth_handler.go       # Login/Register
│   │   │   ├── product_handler.go    # Product endpoints
│   │   │   ├── bom_handler.go        # BoM endpoints
│   │   │   ├── eco_handler.go        # ECO endpoints
│   │   │   ├── operation_handler.go  # Operations endpoints
│   │   │   ├── audit_handler.go      # Audit log endpoints
│   │   │   └── middleware.go         # Auth & logging middleware
│   │   ├── models/                   # Data structures
│   │   │   └── models.go
│   │   ├── repositories/             # Database queries
│   │   │   ├── product_repo.go
│   │   │   ├── bom_repo.go
│   │   │   ├── eco_repo.go
│   │   │   ├── operation_repo.go
│   │   │   ├── audit_repo.go
│   │   │   └── user_repo.go
│   │   └── services/                 # Business logic
│   │       ├── auth_service.go
│   │       ├── product_service.go
│   │       ├── bom_service.go
│   │       ├── eco_service.go        # ECO workflow engine
│   │       ├── operation_service.go
│   │       ├── diff_service.go       # Diff computation
│   │       └── email_service.go      # Notifications
│   ├── migrations/                   # Database migration scripts
│   │   ├── 001_initial_schema.sql
│   │   ├── 002_add_username.sql
│   │   └── ...
│   ├── go.mod                        # Go module dependencies
│   ├── main.go                       # (if exists)
│   └── Dockerfile                    # Container image for backend
│
├── frontend/                         # React frontend
│   ├── src/
│   │   ├── components/               # Reusable React components
│   │   ├── context/                  # React Context providers
│   │   ├── pages/                    # Page components
│   │   ├── services/                 # API client services
│   │   ├── App.jsx                   # Root component
│   │   ├── main.jsx                  # React entry point
│   │   └── index.css                 # Global styles
│   ├── package.json                  # NPM dependencies
│   ├── vite.config.js                # Vite configuration
│   ├── tailwind.config.js            # Tailwind CSS setup
│   ├── postcss.config.js             # PostCSS configuration
│   ├── index.html                    # HTML template
│   ├── nginx.conf                    # Nginx reverse proxy config
│   └── Dockerfile                    # Container image for frontend
│
├── docker-compose.yaml               # Multi-container orchestration
├── ECOFlow_Feature_Spec.md           # Detailed feature specification
├── TEST_DATA_EXAMPLES.md             # Sample test data
└── README.md                         # This file

---

🚀 Getting Started

Prerequisites

• Docker & Docker Compose (recommended)
• Go 1.18+ (if running locally without Docker)
• Node.js 16+ (if running frontend locally)
• PostgreSQL 12+ (if not using Docker)

Quick Start with Docker

1. Clone the repository:

   git clone https://github.com/yourusername/ECO_FLOW_Odoo.git
   cd ECO_FLOW_Odoo

2. Create environment file:

   cp .env.example .env
   # Edit .env with your configuration

3. Start the application:

   docker-compose up -d

4. Run database migrations:

   docker-compose exec backend ./migrate

5. Access the application:

   • Frontend: http://localhost:3000
   • API: http://localhost:8080
   • API Docs: http://localhost:8080/docs (if enabled)

Local Development

Backend Setup:

cd backend
go mod download
go run cmd/api/main.go

Frontend Setup:

cd frontend
npm install
npm run dev

---

👥 User Roles & Permissions

Role	Create ECO	Edit Draft	Submit for Review	Approve/Reject	Apply Change	View Active	View Drafts
Engineering User	✅	✅	✅	❌	❌	✅	✅ (Own)
Approver	❌	❌	❌	✅	✅	✅	✅ (All)
Operations User	❌	❌	❌	❌	❌	✅	❌
Admin	✅	✅	✅	✅	✅	✅	✅

---

🗄️ Database Schema

Key Tables

┌─────────────────────────┐       ┌──────────────────────┐
│      users              │       │    products          │
├─────────────────────────┤       ├──────────────────────┤
│ id (PK)                 │       │ id (PK)              │
│ email                   │       │ name                 │
│ username                │       │ version              │
│ password_hash           │       │ is_active            │
│ full_name               │       │ is_archived          │
│ role                    │       │ sale_price           │
│ created_at              │       │ cost_price           │
│ updated_at              │       │ created_at           │
└─────────────────────────┘       │ updated_at           │
                                  └──────────────────────┘
           ↑                                ↑
           └──── (FK: created_by) ─────────┘

┌──────────────────────────┐     ┌────────────────────────┐
│      ecos                │     │   bom_headers          │
├──────────────────────────┤     ├────────────────────────┤
│ id (PK)                  │     │ id (PK)                │
│ eco_number               │     │ product_id (FK)        │
│ type (Product/BoM)       │     │ product_version        │
│ status                   │     │ version                │
│ submitted_by (FK)        │     │ is_active              │
│ approved_by (FK)         │     │ is_archived            │
│ draft_data (JSON)        │     │ created_at             │
│ created_at               │     └────────────────────────┘
│ applied_at               │
└──────────────────────────┘     ┌────────────────────────┐
                                 │   bom_lines            │
                                 ├────────────────────────┤
                                 │ id (PK)                │
                                 │ bom_header_id (FK)     │
                                 │ component_id (FK)      │
                                 │ quantity               │
                                 │ work_center            │
                                 │ manufacturing_time     │
                                 └────────────────────────┘

┌──────────────────────────┐
│    audit_logs            │
├──────────────────────────┤
│ id (PK)                  │
│ action (CREATE/UPDATE)   │
│ table_name               │
│ record_id                │
│ old_data (JSON)          │
│ new_data (JSON)          │
│ changed_by (FK: users)   │
│ timestamp                │
└──────────────────────────┘

---

📡 API Endpoints

Authentication

POST   /api/auth/login          # User login
POST   /api/auth/register       # User registration
POST   /api/auth/logout         # User logout
GET    /api/auth/me             # Get current user

Products

GET    /api/products            # List active products
GET    /api/products/:id        # Get product details
GET    /api/products/:id/versions  # Get all versions

Bill of Materials

GET    /api/boms                # List active BoMs
GET    /api/boms/:id            # Get BoM details
GET    /api/boms/:id/components # Get BoM components

Engineering Change Orders

POST   /api/ecos                # Create new ECO
GET    /api/ecos                # List ECOs
GET    /api/ecos/:id            # Get ECO details
PUT    /api/ecos/:id/draft      # Update ECO draft
POST   /api/ecos/:id/submit     # Submit for review
POST   /api/ecos/:id/approve    # Approve ECO
POST   /api/ecos/:id/reject     # Reject ECO
POST   /api/ecos/:id/apply      # Apply ECO to production
GET    /api/ecos/:id/diff       # Get diff visualization

Audit & Compliance

GET    /api/audit               # Get audit logs
GET    /api/audit/:table/:id    # Get history for record

---

🔐 Security Features

• ✅ JWT Authentication - Secure token-based auth
• ✅ Role-Based Access Control - Middleware-enforced permissions
• ✅ Audit Trails - All changes logged with user & timestamp
• ✅ Transaction Safety - ECO apply uses DB transactions
• ✅ Input Validation - Server-side validation on all endpoints
• ✅ CORS Configuration - Restricted cross-origin requests
• ✅ Password Hashing - bcrypt hashing for passwords
• ✅ Environment Secrets - .env for sensitive config

---

Code Standards

• Go: Follow Go conventions, use gofmt
• JavaScript: Use ES6+, follow Airbnb style guide
• Commits: Use conventional commits (feat:, fix:, docs:, etc.)

--