admin 48ed74a27b
Some checks are pending
Spec Validation / validate-markdown (push) Waiting to run
Spec Validation / validate-diagrams (push) Waiting to run
Spec Validation / check-todos (push) Waiting to run
251216:1715 Docunment Number: Update frontend/ and แก้ไข Gemini Code Assist
2025-12-16 17:15:09 +07:00
2025-12-04 16:50:09 +07:00
2025-11-17 16:48:49 +07:00
2025-12-06 14:42:32 +07:00

📋 LCBP3-DMS - Document Management System

Laem Chabang Port Phase 3 - Document Management System

ระบบบริหารจัดการเอกสารโครงการแบบครบวงจร สำหรับโครงการก่อสร้างท่าเรือแหลมฉบังระยะที่ 3

Version License Status


📈 Current Status (As of 2025-12-13)

Overall Progress: ~95% Feature Complete - Production Ready

  • Backend: All 18 core modules implemented (~95%)
  • Frontend: All 15 UI tasks completed (100%)
  • Database: Schema v1.6.0 active with complete seed data
  • Documentation: Comprehensive specs/ at v1.6.0
  • Admin Tools: Workflow & Numbering configuration UIs complete
  • 🔄 Testing: E2E tests and UAT in progress
  • 📋 Next: Production deployment preparation

🎯 ภาพรวมโครงการ

LCBP3-DMS เป็นระบบบริหารจัดการเอกสารโครงการที่ออกแบบมาเพื่อรองรับการทำงานของโครงการก่อสร้างขนาดใหญ่ โดยเน้นที่:

  • ความปลอดภัยสูงสุด - Security-first approach ด้วย RBAC 4 ระดับ
  • ความถูกต้องของข้อมูล - Data Integrity ผ่าน Transaction และ Locking Mechanisms
  • ความยืดหยุ่น - Unified Workflow Engine รองรับ Workflow ที่ซับซ้อน
  • ความทนทาน - Resilience Patterns และ Error Handling ที่ครอบคลุม

ฟีเจอร์หลัก

  • 📝 Correspondence Management - จัดการเอกสารโต้ตอบระหว่างองค์กร
  • 🔧 RFA Management - ระบบขออนุมัติเอกสารทางเทคนิค
  • 📐 Drawing Management - จัดการแบบก่อสร้างและแบบคู่สัญญา
  • 🔄 Workflow Engine - DSL-based workflow สำหรับกระบวนการอนุมัติ
  • 📊 Advanced Search - ค้นหาเอกสารด้วย Elasticsearch
  • 🔐 RBAC 4-Level - ควบคุมสิทธิ์แบบละเอียด (Global, Organization, Project, Contract)
  • 📁 Two-Phase File Storage - จัดการไฟล์แบบ Transactional พร้อม Virus Scanning
  • 🔢 Document Numbering - สร้างเลขที่เอกสารอัตโนมัติ ป้องกัน Race Condition

🏗️ สถาปัตยกรรมระบบ

Technology Stack

Backend (NestJS)

{
  "framework": "NestJS (TypeScript, ESM)",
  "database": "MariaDB 11.8",
  "orm": "TypeORM",
  "authentication": "JWT + Passport",
  "authorization": "CASL (RBAC)",
  "search": "Elasticsearch",
  "cache": "Redis",
  "queue": "BullMQ",
  "fileUpload": "Multer + ClamAV",
  "notification": "Nodemailer + n8n (LINE)",
  "documentation": "Swagger"
}

Frontend (Next.js)

{
  "framework": "Next.js 14+ (App Router)",
  "language": "TypeScript",
  "styling": "Tailwind CSS",
  "components": "shadcn/ui",
  "stateManagement": {
    "server": "TanStack Query (React Query)",
    "forms": "React Hook Form + Zod",
    "ui": "useState/useReducer"
  },
  "testing": "Vitest + Playwright"
}

Infrastructure

  • Server: QNAP TS-473A (AMD Ryzen V1500B, 32GB RAM)
  • Containerization: Docker + Docker Compose (Container Station)
  • Reverse Proxy: Nginx Proxy Manager
  • Version Control: Gitea (Self-hosted)
  • Domain: np-dms.work

โครงสร้างระบบ

┌─────────────────┐
│  Nginx Proxy    │ ← SSL/TLS Termination
│    Manager      │
└────────┬────────┘
         │
    ┌────┴────┬────────────┬──────────┐
    │         │            │          │
┌───▼───┐ ┌──▼──┐  ┌─────▼────┐ ┌──▼──┐
│Next.js│ │NestJS│ │Elasticsearch│ │ n8n │
│Frontend│ │Backend│ │  Search   │ │Workflow│
└───────┘ └──┬──┘  └──────────┘ └─────┘
             │
    ┌────────┼────────┐
    │        │        │
┌───▼───┐ ┌─▼──┐ ┌──▼────┐
│MariaDB│ │Redis│ │ClamAV │
│  DB   │ │Cache│ │ Scan  │
└───────┘ └────┘ └───────┘

🚀 เริ่มต้นใช้งาน

ข้อกำหนดระบบ

  • Node.js: v20.x หรือสูงกว่า
  • pnpm: v8.x หรือสูงกว่า
  • Docker: v24.x หรือสูงกว่า
  • MariaDB: 11.8
  • Redis: 7.x

การติดตั้ง

1. Clone Repository

git clone https://git.np-dms.work/lcbp3/lcbp3-dms.git
cd lcbp3-dms

2. ติดตั้ง Dependencies

# ติดตั้ง dependencies ทั้งหมด (backend + frontend)
pnpm install

3. ตั้งค่า Environment Variables

Backend:

cd backend
cp .env.example .env
# แก้ไข .env ตามความเหมาะสม

Frontend:

cd frontend
cp .env.local.example .env.local
# แก้ไข .env.local ตามความเหมาะสม

4. ตั้งค่า Database

# Import schema
mysql -u root -p lcbp3_dev < docs/8_lcbp3_v1_4_5.sql

# Import seed data
mysql -u root -p lcbp3_dev < docs/8_lcbp3_v1_4_5_seed.sql

5. รัน Development Server

Backend:

cd backend
pnpm run start:dev

Frontend:

cd frontend
pnpm run dev

การเข้าถึงระบบ

  • Frontend: http://localhost:3000
  • Backend API: http://localhost:3001
  • API Documentation: http://localhost:3001/api

ข้อมูลเข้าสู่ระบบเริ่มต้น

Superadmin:
  Username: admin@np-dms.work
  Password: (ดูใน seed data)

📁 โครงสร้างโปรเจกต์

lcbp3-dms/
├── backend/                    # 🔧 NestJS Backend
│   ├── src/
│   │   ├── common/             # Shared utilities, guards, decorators
│   │   ├── config/             # Configuration module
│   │   ├── database/           # Database entities & migrations
│   │   ├── modules/            # Feature modules (17 modules)
│   │   │   ├── auth/           # JWT Authentication
│   │   │   ├── user/           # User management & RBAC
│   │   │   ├── project/        # Project & Contract management
│   │   │   ├── correspondence/ # Correspondence module
│   │   │   ├── rfa/            # Request for Approval
│   │   │   ├── drawing/        # Contract & Shop Drawings
│   │   │   ├── workflow-engine/# DSL Workflow Engine
│   │   │   ├── document-numbering/ # Auto numbering
│   │   │   ├── transmittal/    # Transmittal management
│   │   │   ├── circulation/    # Circulation sheets
│   │   │   ├── search/         # Elasticsearch integration
│   │   │   ├── dashboard/      # Statistics & reporting
│   │   │   ├── notification/   # Email/LINE notifications
│   │   │   ├── monitoring/     # Health checks & metrics
│   │   │   ├── master/         # Master data management
│   │   │   ├── organizations/  # Organization management
│   │   │   └── json-schema/    # JSON Schema validation
│   │   └── main.ts
│   ├── test/                   # Unit & E2E tests
│   └── package.json
│
├── frontend/                   # 🎨 Next.js Frontend
│   ├── app/                    # App Router
│   │   ├── (admin)/            # Admin panel routes
│   │   │   └── admin/
│   │   │       ├── workflows/  # Workflow configuration
│   │   │       ├── numbering/  # Document numbering config
│   │   │       ├── users/      # User management
│   │   │       └── ...
│   │   ├── (auth)/             # Authentication pages
│   │   ├── (dashboard)/        # Main dashboard routes
│   │   │   ├── correspondences/
│   │   │   ├── rfas/
│   │   │   ├── drawings/
│   │   │   └── ...
│   │   └── api/                # API routes (NextAuth)
│   ├── components/             # React Components (15 groups)
│   │   ├── ui/                 # Shadcn/UI components
│   │   ├── layout/             # Layout components
│   │   ├── common/             # Shared components
│   │   ├── correspondences/    # Correspondence UI
│   │   ├── rfas/               # RFA UI
│   │   ├── drawings/           # Drawing UI
│   │   ├── workflows/          # Workflow builder
│   │   ├── numbering/          # Numbering config UI
│   │   ├── dashboard/          # Dashboard widgets
│   │   ├── search/             # Search components
│   │   └── ...
│   ├── lib/                    # Utilities & API clients
│   │   ├── api/                # API client functions
│   │   ├── services/           # Business logic services
│   │   └── stores/             # Zustand state stores
│   ├── types/                  # TypeScript definitions
│   └── package.json
│
├── specs/                      # 📘 Project Specifications (v1.5.1)
│   ├── 00-overview/            # Project overview & glossary
│   ├── 01-requirements/        # Functional requirements (21 docs)
│   ├── 02-architecture/        # System architecture
│   ├── 03-implementation/      # Implementation guidelines
│   ├── 04-operations/          # Deployment & operations
│   ├── 05-decisions/           # ADRs (17 decisions)
│   ├── 06-tasks/               # Active tasks & progress
│   ├── 07-database/            # Schema v1.5.1 & seed data
│   └── 09-history/             # Archived implementations
│
├── docs/                       # 📚 Legacy documentation
├── diagrams/                   # 📊 Architecture diagrams
├── infrastructure/             # 🐳 Docker & Deployment configs
│
├── .gemini/                    # 🤖 AI agent configuration
├── .agent/                     # Agent workflows
├── GEMINI.md                   # AI coding guidelines
├── CONTRIBUTING.md             # Contribution guidelines
├── CHANGELOG.md                # Version history
└── pnpm-workspace.yaml         # Monorepo configuration

📚 เอกสารประกอบ

เอกสารหลัก (specs/ folder)

เอกสาร คำอธิบาย โฟลเดอร์
Overview ภาพรวมโครงการ, Glossary specs/00-overview/
Requirements ข้อกำหนดระบบและฟังก์ชันการทำงาน specs/01-requirements/
Architecture สถาปัตยกรรมระบบ, ADRs specs/02-architecture/
Implementation แนวทางการพัฒนา Backend/Frontend specs/03-implementation/
Database Schema v1.6.0 + Seed Data specs/07-database/

Schema & Seed Data

# Import schema
mysql -u root -p lcbp3_dev < specs/07-database/lcbp3-v1.6.0-schema.sql

# Import seed data
mysql -u root -p lcbp3_dev < specs/07-database/lcbp3-v1.6.0-seed-basic.sql

Legacy Documentation

เอกสารเก่าอยู่ใน docs/ folder


🔧 Development Guidelines

Coding Standards

ภาษาที่ใช้

  • Code: ภาษาอังกฤษ (English)
  • Comments & Documentation: ภาษาไทย (Thai)

TypeScript Rules

// ✅ ถูกต้อง
interface User {
  user_id: number; // Property: snake_case
  firstName: string; // Variable: camelCase
  isActive: boolean; // Boolean: Verb + Noun
}

// ❌ ผิด
interface User {
  userId: number; // ไม่ใช้ camelCase สำหรับ property
  first_name: string; // ไม่ใช้ snake_case สำหรับ variable
  active: boolean; // ไม่ใช้ Verb + Noun
}

File Naming

user-service.ts          ✅ kebab-case
UserService.ts           ❌ PascalCase
user_service.ts          ❌ snake_case

Git Workflow

# สร้าง feature branch
git checkout -b feature/correspondence-module

# Commit message format
git commit -m "feat(correspondence): add create correspondence endpoint"

# Types: feat, fix, docs, style, refactor, test, chore

Testing

# Backend
cd backend
pnpm test              # Unit tests
pnpm test:e2e         # E2E tests
pnpm test:cov         # Coverage

# Frontend
cd frontend
pnpm test             # Unit tests
pnpm test:e2e         # Playwright E2E

🔐 Security

Security Features

  • JWT Authentication - Access & Refresh Tokens
  • RBAC 4-Level - Global, Organization, Project, Contract
  • Rate Limiting - ป้องกัน Brute-force
  • Virus Scanning - ClamAV สำหรับไฟล์ที่อัปโหลด
  • Input Validation - ป้องกัน SQL Injection, XSS, CSRF
  • Idempotency - ป้องกันการทำรายการซ้ำ
  • Audit Logging - บันทึกการกระทำทั้งหมด

Security Best Practices

  1. ห้ามเก็บ Secrets ใน Git

    • ใช้ .env สำหรับ Development
    • ใช้ docker-compose.override.yml (gitignored)
  2. Password Policy

    • ความยาวขั้นต่ำ: 8 ตัวอักษร
    • ต้องมี uppercase, lowercase, number, special character
    • เปลี่ยน password ทุก 90 วัน
  3. File Upload

    • White-list file types: PDF, DWG, DOCX, XLSX, ZIP
    • Max size: 50MB
    • Virus scan ทุกไฟล์

🧪 Testing Strategy

Test Pyramid

       /\
      /  \     E2E Tests (10%)
     /____\
    /      \   Integration Tests (20%)
   /________\
  /          \ Unit Tests (70%)
 /____________\

Coverage Goals

  • Backend: 70%+ overall
    • Business Logic: 80%+
    • Controllers: 70%+
    • Utilities: 90%+
  • Frontend: 60%+ overall

📊 Monitoring & Observability

Health Checks

# Backend health
curl http://localhost:3001/health

# Database health
curl http://localhost:3001/health/db

# Redis health
curl http://localhost:3001/health/redis

Metrics

  • API Response Time
  • Error Rates
  • Cache Hit Ratio
  • Database Connection Pool
  • File Upload Performance

🚢 Deployment

Production Deployment

# Build backend
cd backend
pnpm run build

# Build frontend
cd frontend
pnpm run build

# Deploy with Docker Compose
docker-compose -f docker-compose.yml up -d

Environment-specific Configs

  • Development: .env, docker-compose.override.yml
  • Staging: Environment variables ใน Container Station
  • Production: Docker secrets หรือ Vault

🤝 Contributing

กรุณาอ่าน CONTRIBUTING.md สำหรับรายละเอียดเกี่ยวกับ:

  • Code of Conduct
  • Development Process
  • Pull Request Process
  • Coding Standards

📝 License

This project is Internal Use Only - ลิขสิทธิ์เป็นของโครงการ LCBP3


👥 Team

  • Project Manager: [์Nattanin Peancharoen]
  • Tech Lead: [Nattanin Peancharoen]
  • Backend Team: [Nattanin Peancharoen]
  • Frontend Team: [Nattanin Peancharoen]

📞 Support

สำหรับคำถามหรือปัญหา กรุณาติดต่อ:


🗺️ Roadmap

Version 1.5.1 (Current - Dec 2025) FEATURE COMPLETE

Backend (18 Modules - ~95%)

  • Core Infrastructure (Auth, RBAC, File Storage)
  • Authentication & Authorization (JWT + CASL RBAC 4-Level)
  • Correspondence Module (Master-Revision Pattern)
  • RFA Module (Full CRUD + Workflow)
  • Drawing Module (Contract + Shop Drawings)
  • Workflow Engine (DSL-based Hybrid)
  • Document Numbering (Redlock + Optimistic Locking)
  • Search (Elasticsearch Direct Indexing)
  • Transmittal & Circulation Modules
  • Notification & Audit Systems
  • Master Data Management
  • User Management
  • Dashboard & Monitoring
  • Swagger API Documentation

Frontend (15 Tasks - 100%)

  • Complete UI Implementation (17 component groups)
  • All Business Modules (Correspondence, RFA, Drawings)
  • Admin Panel (10 routes including Workflow & Numbering Config)
  • Dashboard with Real-time Statistics
  • Advanced Search UI
  • RBAC Permission UI
  • Responsive Layout (Desktop & Mobile)

Documentation

  • Complete specs/ v1.6.0 (21 requirements, 17 ADRs)
  • Database Schema v1.6.0 with seed data
  • Implementation & Operations Guides

Version 1.7.0 (Planned - Q1 2026)

Production Enhancements

  • 📋 E2E Test Coverage (Playwright/Cypress)
  • 📊 Advanced Reporting & Analytics Dashboard
  • 🔔 Enhanced Notifications (Real-time WebSocket)
  • 📈 Prometheus Metrics & Grafana Dashboards
  • 🔍 Queue-based Elasticsearch Indexing
  • 🚀 Performance Optimization & Caching Strategy
  • 📱 Mobile App (React Native)

Optional Improvements

  • 🤖 AI-powered Document Classification
  • 📧 Advanced Email Templates
  • 🔐 SSO Integration (LDAP/Active Directory)
  • 📦 Bulk Operations & Import/Export Tools

📖 Additional Resources

API Documentation

Architecture Diagrams

Learning Resources


Built with ❤️ for LCBP3 Project

DocumentationIssuesChangelog

Description
No description provided
Readme 245 MiB
Languages
TypeScript 94.8%
PowerShell 3%
HTML 1.7%
CSS 0.3%
JavaScript 0.2%