Files
docs/archive/99-ARCHIVE/INDEX-OLD-v1.0.md
T
masoodafar-web 5965b98728 update
2026-01-03 18:27:49 +03:30

11 KiB

FourSat Project - Documentation Index

تمام مستندات سامانه‌های FourSat در این فولدر تجمیع شده‌اند

تاریخ ایجاد: 2025-12-01
آخرین بروزرسانی: 2025-12-01
تعداد کل فایل‌ها: 24 فایل markdown + 7 فایل پشتیبان (SQL, NDM2, TXT)


📊 وضعیت کلی پروژه

سیستم پیشرفت وضعیت توضیحات
BackOffice 95% 🟢 Production Ready 23 صفحه، 30 BFF Handler، 0 خطا
CMS 95% 🟢 Production Ready MVP 100% - Email/SMS آماده
BackOffice.BFF 100% 🟢 Production Ready 30 Handler کامل
FrontOffice 40% 🟡 In Progress UI در حال توسعه
FrontOffice.BFF 50% 🟡 In Progress APIها جزئی

📋 ساختار مستندات

1️⃣ BackOffice (مدیریت)

مسیر: BackOffice/

فایل شرح
README.md معرفی کلی پروژه BackOffice
development-plan.md برنامه توسعه و پیشرفت پروژه (92% تکمیل)

آخرین وضعیت (2025-12-01):

  • 23 صفحه پیاده‌سازی شده
  • 30 BFF Handler (Commission: 15, Network: 9, Club: 6)
  • معماری 3-لایه (UI → BFF → CMS)
  • Build با 0 خطا
  • Withdrawal APIs کامل شد
  • Worker Control APIs کامل شد

2️⃣ BackOffice.BFF (Backend For Frontend - مدیریت)

مسیر: BackOffice.BFF/

فایل شرح
README.md معرفی کلی BFF مدیریت
cms-integration.md راهنمای یکپارچه‌سازی با CMS
.github/git-commit-instructions.md استانداردهای Commit Message
docs/model.ndm2 مدل دیتابیس (Navicat)

توضیحات:

  • لایه واسط بین UI مدیریت و CMS
  • مدیریت gRPC Clients
  • Mapping و Validation

3️⃣ FrontOffice (کاربران)

مسیر: FrontOffice/

فایل شرح
README.md معرفی کلی پروژه FrontOffice
mudblazor_classes.md راهنمای استایل‌ها و کلاس‌های MudBlazor

توضیحات:

  • رابط کاربری برای مشتریان
  • استفاده از MudBlazor Component Library

4️⃣ FrontOffice.BFF (Backend For Frontend - کاربران)

مسیر: FrontOffice.BFF/

فایل شرح
README.md معرفی کلی BFF کاربران
docs/CMS.sql اسکریپت SQL
docs/model.ndm2 مدل دیتابیس (Navicat)

توضیحات:

  • لایه واسط بین UI کاربران و CMS
  • مدیریت Authentication و Authorization

5️⃣ CMS (Content Management System)

مسیر: CMS/

فایل شرح کاربرد
README.md معرفی کلی CMS + Quick Start عمومی
cms-data-and-business.md معماری دیتا و بیزینس لاجیک معماری
network-club-commission-system.md سیستم شبکه، باشگاه و کمیسیون (نسخه اول) Business Logic
network-club-commission-system-v1.1.md سیستم شبکه، باشگاه و کمیسیون (نسخه 1.1) Business Logic
binary-tree-registration-guide.md راهنمای ثبت‌نام درختی باینری راهنمای توسعه
migration-network-parent-guide.md راهنمای مهاجرت NetworkParent راهنمای توسعه
implementation-progress.md گزارش پیشرفت پیاده‌سازی (90% تکمیل) Progress Report
implementation-progress-fa.md گزارش پیشرفت پیاده‌سازی (فارسی) Progress Report
daya-loan-integration.md سیستم یکپارچه‌سازی وام دایا (90% تکمیل) Feature Implementation
manual-payment-system.md سیستم پرداخت دستی مشتریان (Design Complete) Feature Design
monitoring-alerts-implementation-report.md گزارش پیاده‌سازی Monitoring و Alerts Feature Report
monitoring-alerts-consolidated-report.md گزارش تجمیعی Monitoring و Alerts Feature Report
email-sms-configuration-guide.md راهنمای تنظیم Email/SMS (MailKit + Kavenegar) Configuration
balance-calculation-carryover-logic.md منطق محاسبه Balance و CarryOver Business Logic
model.ndm2, model1.ndm2 مدل‌های دیتابیس (Navicat) Database
update-pool-percent.sql اسکریپت SQL برای به‌روزرسانی Pool Percent Database
network_crm_calculate.txt یادداشت‌های محاسبات شبکه CRM Notes
REMAINING-TASKS.md لیست کامل کارهای باقی‌مانده با اولویت‌بندی Planning

ویژگی‌های کلیدی:

  • 🌳 سیستم شبکه‌سازی باینری (Binary Tree)
  • 💰 محاسبه و توزیع کمیسیون هفتگی
  • 🏆 سیستم باشگاه مشتریان (Club Membership)
  • 📊 Dashboard های آماری و مانیتورینگ
  • ⚠️ سیستم هشدارها و اعلان‌ها
  • 📧 Email/SMS Notifications (MailKit + Kavenegar)
  • 🔄 Hangfire Job Scheduling
  • 💊 Health Checks (Kubernetes-ready)

🎯 دسته‌بندی موضوعی

معماری و طراحی

  • CMS/cms-data-and-business.md
  • BackOffice.BFF/cms-integration.md

Business Logic اصلی

  • CMS/network-club-commission-system-v1.1.md (آخرین نسخه)
  • CMS/network-club-commission-system.md
  • CMS/balance-calculation-carryover-logic.md (منطق محاسبات)

راهنماهای توسعه

  • CMS/binary-tree-registration-guide.md
  • CMS/migration-network-parent-guide.md
  • CMS/email-sms-configuration-guide.md
  • FrontOffice/mudblazor_classes.md
  • BackOffice.BFF/.github/git-commit-instructions.md

گزارش‌های پیشرفت

  • BackOffice/development-plan.md (88% تکمیل)
  • CMS/implementation-progress.md
  • CMS/implementation-progress-fa.md

Feature Reports

  • CMS/monitoring-alerts-implementation-report.md
  • CMS/monitoring-alerts-consolidated-report.md

📊 آمار کلی پروژه

BackOffice (UI مدیریت)

  • صفحات: 23 صفحه
  • پیشرفت: 88%
  • وضعیت Build: موفق (0 خطا)

CMS (Backend اصلی)

  • Entities: 30+ موجودیت
  • APIs: 100+ endpoint
  • وضعیت Build: موفق (0 خطا)

سیستم کمیسیون و شبکه

  • وضعیت: پیاده‌سازی شده
  • محاسبات: هفتگی، خودکار
  • Binary Tree: کامل با spillover

🔄 آخرین تغییرات (2025-12-01)

Phase 4: MVP Complete

  1. Email/SMS Notification System

    • MailKit 4.14.1 (SMTP Email with HTML templates)
    • Kavenegar 1.2.5 (Iranian SMS gateway)
    • User.Email field added with migration
    • 3 notification types: Commission, Club activation, Errors
  2. Hangfire Job Scheduling

    • Dashboard UI at /hangfire
    • Cron: Sunday 00:05 UTC
    • SQL Server persistence
    • Manual trigger API
  3. Infrastructure Enhancements

    • Health Check endpoints (/health, /health/ready, /health/live)
    • AlertService (structured logging)
    • Retry logic (Polly 8.5.0)
    • WorkerExecutionLog (audit trail)
  4. BackOffice Integration

    • Configuration page (4 tabs)
    • Withdrawal APIs complete
    • Worker Control APIs complete

📞 نکات مهم برای توسعه‌دهندگان

مستندات حیاتی

  1. 🚀 شروع سریع: QUICK-START-DEVELOPMENT.md (راهنمای گام‌به‌گام توسعه از صفر)
  2. ⚠️ بررسی بیزینس: BUSINESS-VERIFICATION-TEMPLATE.md (تمپلیت گزارش ماهانه)
  3. 🔍 مقایسه CMS vs BFF: CMS-API-COVERAGE.md (چه APIهایی باقی مانده؟)
  4. کارهای باقی‌مانده: REMAINING-TASKS.md (اولویت‌بندی شده + چک‌لیست بیزینس)
  5. شروع پروژه جدید: README.md هر پروژه
  6. درک Business Logic: CMS/network-club-commission-system-v1.1.md
  7. راه‌اندازی توسعه: BackOffice/development-plan.md
  8. یکپارچه‌سازی: BackOffice.BFF/cms-integration.md

فایل‌های کمکی

  • UI Styling: FrontOffice/mudblazor_classes.md
  • Database Migration: CMS/migration-network-parent-guide.md
  • Tree Registration: CMS/binary-tree-registration-guide.md
  • Email/SMS Setup: CMS/email-sms-configuration-guide.md

🗂️ ساختار فایل‌ها

totalDoc/
├── INDEX.md (این فایل)
├── README.md
├── REMAINING-TASKS.md ⭐ (کارهای باقی‌مانده + بیزینس‌های کلیدی)
├── BUSINESS-VERIFICATION-TEMPLATE.md ⚠️ (تمپلیت گزارش بررسی ماهانه)
├── CMS-API-COVERAGE.md 🔍 (مقایسه CMS vs BFF)
├── QUICK-START-DEVELOPMENT.md 🚀 (راهنمای شروع سریع توسعه)
├── BackOffice/
│   ├── README.md
│   └── development-plan.md
├── BackOffice.BFF/
│   ├── README.md
│   ├── cms-integration.md
│   ├── .github/
│   │   └── git-commit-instructions.md
│   └── docs/
│       └── model.ndm2
├── FrontOffice/
│   ├── README.md
│   └── mudblazor_classes.md
├── FrontOffice.BFF/
│   ├── README.md
│   └── docs/
│       ├── CMS.sql
│       └── model.ndm2
└── CMS/
    ├── README.md
    ├── cms-data-and-business.md
    ├── network-club-commission-system.md
    ├── network-club-commission-system-v1.1.md
    ├── binary-tree-registration-guide.md
    ├── migration-network-parent-guide.md
    ├── implementation-progress.md
    ├── implementation-progress-fa.md
    ├── monitoring-alerts-implementation-report.md
    ├── monitoring-alerts-consolidated-report.md
    ├── email-sms-configuration-guide.md
    ├── balance-calculation-carryover-logic.md
    ├── model.ndm2
    ├── model1.ndm2
    ├── update-pool-percent.sql
    └── network_crm_calculate.txt

⚠️ نکته مهم

تمام فایل‌های markdown به totalDoc/ منتقل شده‌اند (MOVED نه COPIED).

  • فایل‌های .md فقط در totalDoc/ هستند
  • فایل‌های دیگر (SQL, NDM2, TXT) در مسیرهای اصلی باقی‌مانده‌اند
  • تغییرات مستقیماً در totalDoc/ انجام می‌شود
  • دیگر نیازی به همگام‌سازی نیست