feat: Complete overhaul of FourSat documentation structure and content
- Added FINAL-STATUS.md detailing project completion and key metrics - Created QUICK-REFERENCE.md for quick access to essential documents - Updated README.md with project overview and quick start guide - Established STRUCTURE.md outlining the final documentation structure - Organized and archived old files, ensuring a clean and efficient directory - Enhanced documentation quality with comprehensive metrics and checklists
This commit is contained in:
masoodafar-web
+1410
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,203 @@
|
||||
# 🎯 اسپرینت جاری (Current Sprint)
|
||||
|
||||
**تاریخ شروع**: ۱۴ آذر ۱۴۰۴
|
||||
**مدت**: 2 هفته
|
||||
**هدف**: تکمیل FrontOffice UI و یکپارچهسازی BFF
|
||||
|
||||
---
|
||||
|
||||
## 📋 وضعیت کلی پروژه
|
||||
|
||||
### Backend:
|
||||
- ✅ **CMS Microservice**: 95% Complete (Phase 9 & 12 Complete)
|
||||
- ✅ **BackOffice.BFF**: 100% Complete (35 Handlers)
|
||||
- 🚧 **FrontOffice.BFF**: 60% Complete (12 Handlers - 3 new today)
|
||||
|
||||
### Frontend:
|
||||
- ✅ **BackOffice UI**: 100% Complete (23 Pages)
|
||||
- 🚧 **FrontOffice UI**: 75% Complete (24 Pages - 7 new today)
|
||||
|
||||
---
|
||||
|
||||
## 🔥 High Priority (باید امروز/فردا تمام شود)
|
||||
|
||||
### 1. FrontOffice UI - Integration با BFF Real APIs ⏰
|
||||
**Status**: 🚧 In Progress (Mock → Real API)
|
||||
**Owner**: Frontend Team
|
||||
**Deadline**: ۱۵ آذر (فردا)
|
||||
|
||||
#### Tasks:
|
||||
- [ ] **ClubMembership صفحات** (3 صفحه)
|
||||
- [ ] `ClubInfo.razor` - اتصال به `GetClubMembershipInfo`
|
||||
- [ ] `ActivateClub.razor` - اتصال به `ActivateClubMembership`
|
||||
- [ ] `ClubFeatures.razor` - اتصال به `GetAvailableClubFeatures`
|
||||
|
||||
- [ ] **NetworkMembership صفحات** (2 صفحه)
|
||||
- [ ] `Tree.razor` - اتصال به `GetNetworkTree` + Tree Builder
|
||||
- [ ] `NetworkStats.razor` - اتصال به `GetNetworkStatistics`
|
||||
|
||||
- [ ] **Commission صفحات** (2 صفحه)
|
||||
- [ ] `WeeklyReport.razor` - اتصال به `GetWeeklyCommissionReport`
|
||||
- [ ] `PayoutHistory.razor` - اتصال به `GetUserPayouts`
|
||||
|
||||
**Blockers**:
|
||||
- ⚠️ Protobuf mismatch (ActivationDate vs ActivatedAt) - نیاز به هماهنگی با Backend
|
||||
- ⚠️ Tree structure در CMS flat list است - نیاز به Tree Builder در BFF
|
||||
|
||||
---
|
||||
|
||||
### 2. FrontOffice.BFF - رفع Protobuf Mismatches ⏰
|
||||
**Status**: 🚧 In Progress
|
||||
**Owner**: Backend Team
|
||||
**Deadline**: ۱۵ آذر
|
||||
|
||||
#### Tasks:
|
||||
- [ ] **ClubMembershipHandler** - تطبیق field names
|
||||
```csharp
|
||||
// CMS: ActivationDate → BFF: ActivatedAt
|
||||
// FIX: Rename in proto or add mapping
|
||||
```
|
||||
|
||||
- [ ] **NetworkMembershipHandler** - پیادهسازی Tree Builder
|
||||
```csharp
|
||||
// CMS: Flat list → BFF: Tree structure
|
||||
// FIX: Build tree from flat list recursively
|
||||
```
|
||||
|
||||
- [ ] **CommissionHandler** - تطبیق WeekNumber type
|
||||
```csharp
|
||||
// CMS: WeekNumber (int) → BFF: WeekNumber (string)
|
||||
// FIX: Convert int to "YYYY-Www" format
|
||||
```
|
||||
|
||||
**File**: `03-BACKEND/FrontOffice.BFF/protobuf-mismatch.md` دارای جزئیات کامل
|
||||
|
||||
---
|
||||
|
||||
## 🟡 Medium Priority (این هفته)
|
||||
|
||||
### 3. WalletService - پیادهسازی متدهای TODO
|
||||
**Status**: ⏳ Not Started
|
||||
**Owner**: Frontend Team
|
||||
**Deadline**: ۱۷ آذر
|
||||
|
||||
#### Tasks (5 متد):
|
||||
- [ ] `GetUserWalletBalanceAsync()` - دریافت موجودی کیف پول
|
||||
- [ ] `ChargeWalletAsync()` - شارژ کیف پول
|
||||
- [ ] `WithdrawFromWalletAsync()` - برداشت از کیف پول
|
||||
- [ ] `GetWalletTransactionsAsync()` - تاریخچه تراکنشها
|
||||
- [ ] `TransferBetweenWalletsAsync()` - انتقال بین کیف پولها
|
||||
|
||||
**File**: `04-FRONTEND/FrontOffice/todo-commented-code.md`
|
||||
|
||||
---
|
||||
|
||||
### 4. Package Purchase System - UI Implementation
|
||||
**Status**: ⏳ Not Started (Proto Complete ✅)
|
||||
**Owner**: FrontOffice Team
|
||||
**Deadline**: ۱۸ آذر
|
||||
|
||||
#### CMS Status:
|
||||
- ✅ Entities (5) - `PackagePurchase`, `PackagePurchaseItem`, etc.
|
||||
- ✅ Commands (6) - `CreatePackagePurchaseCommand`, etc.
|
||||
- ✅ Queries (3) - `GetPackagePurchaseByIdQuery`, etc.
|
||||
- ✅ Protobuf (4 RPCs) - 264 lines
|
||||
|
||||
#### Pending:
|
||||
- [ ] BFF Handlers (3 modules)
|
||||
- [ ] UI Pages (4 صفحه)
|
||||
- [ ] `Packages.razor` - لیست پکیجها
|
||||
- [ ] `PurchasePackage.razor` - خرید پکیج
|
||||
- [ ] `MyPackages.razor` - پکیجهای من
|
||||
- [ ] `PackageDetails.razor` - جزئیات پکیج
|
||||
|
||||
**Reference**: `01-BUSINESS/package-purchase-system.md`
|
||||
|
||||
---
|
||||
|
||||
## 🟢 Low Priority (هفته بعد)
|
||||
|
||||
### 5. VAT System Implementation
|
||||
**Status**: ⏳ Not Started
|
||||
**Owner**: CMS Team
|
||||
**Estimate**: 2 روز
|
||||
|
||||
#### Requirements:
|
||||
- پیادهسازی محاسبه مالیات بر ارزش افزوده (VAT)
|
||||
- اضافه شدن به Invoice ها
|
||||
- تنظیمات پویا برای درصد VAT
|
||||
|
||||
---
|
||||
|
||||
### 6. RBAC System Implementation
|
||||
**Status**: ⏳ Not Started
|
||||
**Owner**: CMS + BFF Teams
|
||||
**Estimate**: 1.5 هفته
|
||||
|
||||
#### Requirements:
|
||||
- تعریف Roles و Permissions
|
||||
- Policy-based Authorization
|
||||
- Admin Panel برای مدیریت دسترسیها
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ Blockers & Dependencies
|
||||
|
||||
### 🔴 Critical Blockers:
|
||||
1. **Protobuf Mismatch** (FrontOffice.BFF ↔ CMS)
|
||||
- Impact: 3 modules affected
|
||||
- Resolution: Backend coordination needed
|
||||
- ETA: امروز/فردا
|
||||
|
||||
2. **Tree Builder Missing** (NetworkMembership)
|
||||
- Impact: Tree.razor can't display network
|
||||
- Resolution: Implement recursive tree builder in BFF
|
||||
- ETA: 1 روز
|
||||
|
||||
### 🟡 Minor Issues:
|
||||
1. **WalletService Mock Data** - نیاز به پاکسازی بعد از اتصال API
|
||||
2. **MudBlazor Warnings** - 113 warning (غیر critical)
|
||||
|
||||
---
|
||||
|
||||
## 📊 Velocity Tracking
|
||||
|
||||
### کارهای تمام شده امروز (۱۴ آذر):
|
||||
- ✅ FrontOffice UI: 7 صفحه جدید (Club, Network, Commission)
|
||||
- ✅ FrontOffice.BFF: 3 CQ module جدید
|
||||
- ✅ Build Successful: 0 errors
|
||||
- ✅ Documentation: 2 فایل تحلیل جدید
|
||||
|
||||
### تخمین باقیمانده:
|
||||
- **FrontOffice UI Integration**: 2 روز (7 صفحه × 3-4 ساعت)
|
||||
- **Protobuf Fixes**: 1 روز (3 handler)
|
||||
- **WalletService Implementation**: 1 روز (5 متد)
|
||||
- **Package Purchase UI**: 2 روز (4 صفحه + BFF)
|
||||
|
||||
**Total**: ~6 روز کاری (1.5 هفته)
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Definition of Done
|
||||
|
||||
### برای هر Task:
|
||||
- [ ] Code Review Complete
|
||||
- [ ] Build با 0 error
|
||||
- [ ] Manual Testing انجام شده
|
||||
- [ ] Documentation بروز شده
|
||||
- [ ] Merged به `develop` branch
|
||||
|
||||
---
|
||||
|
||||
## 📝 Daily Standup Notes
|
||||
|
||||
### ۱۴ آذر ۱۴۰۴:
|
||||
- **Yesterday**: FrontOffice analysis & UI skeleton
|
||||
- **Today**: 7 new pages + 3 BFF modules + Mock services
|
||||
- **Blockers**: Protobuf mismatch discovered
|
||||
- **Next**: Real API integration tomorrow
|
||||
|
||||
---
|
||||
|
||||
**منتظر بروزرسانی روزانه هستیم** 🚀
|
||||
|
||||
@@ -0,0 +1,250 @@
|
||||
# گزارش بررسی تطبیق بیزینس با کد
|
||||
|
||||
**تاریخ بررسی**: _________
|
||||
**بررسیکننده**: _________
|
||||
**نسخه کد**: _________
|
||||
|
||||
---
|
||||
|
||||
## ✅ بیزینس 1: Binary Tree (درخت دودویی)
|
||||
|
||||
### بررسی کد:
|
||||
```bash
|
||||
# دستور اجرا شده:
|
||||
cd CMS/src/CMSMicroservice.Domain/Entities
|
||||
grep -A 20 "class User" User.cs | grep -E "Parent|Left|Right"
|
||||
```
|
||||
|
||||
### نتیجه:
|
||||
- [ ] ✅ User دارای Parent, LeftChild, RightChild است
|
||||
- [ ] ✅ Spillover Logic پیادهسازی شده
|
||||
- [ ] ✅ Depth محاسبه میشود
|
||||
- [ ] ✅ Parent تغییر نمیکند
|
||||
|
||||
### تست عملی:
|
||||
```
|
||||
ثبتنام 7 کاربر:
|
||||
- User1 (Root)
|
||||
- User2 (Left of 1)
|
||||
- User3 (Right of 1)
|
||||
- User4 (Left of 2) ✓
|
||||
- User5 (Right of 2) ✓
|
||||
- User6 (Left of 3) ✓
|
||||
- User7 (Right of 3) ✓
|
||||
|
||||
نتیجه: [✅ موفق] [❌ ناموفق]
|
||||
```
|
||||
|
||||
### تطبیق با داکیومنت:
|
||||
- فایل: `totalDoc/CMS/binary-tree-registration-guide.md`
|
||||
- وضعیت: [✅ تطبیق کامل] [⚠️ نیاز به بهروزرسانی] [❌ عدم تطبیق]
|
||||
- توضیحات: _________________
|
||||
|
||||
---
|
||||
|
||||
## 💰 بیزینس 2: محاسبه کمیسیون
|
||||
|
||||
### بررسی کد:
|
||||
```bash
|
||||
# Cron Job
|
||||
cd CMS/src/CMSMicroservice.Application/BackgroundWorkers
|
||||
grep "Cron.*Sunday" -r .
|
||||
|
||||
# فرمول
|
||||
grep "TotalPV.*Percentage" -r .
|
||||
```
|
||||
|
||||
### نتیجه:
|
||||
- [ ] ✅ Cron: یکشنبه 00:05 UTC
|
||||
- [ ] ✅ فرمول: Commission = TotalPV × Percentage
|
||||
- [ ] ✅ MinimumPV چک میشود
|
||||
- [ ] ✅ CarryOver به هفته بعد
|
||||
- [ ] ✅ MaxCommission رعایت میشود
|
||||
|
||||
### تست عملی:
|
||||
```
|
||||
User: TestUser1
|
||||
PV این هفته: 1000
|
||||
Percentage: 10%
|
||||
MinimumPV: 500
|
||||
|
||||
محاسبه شده: _______
|
||||
انتظار: 100
|
||||
|
||||
نتیجه: [✅ موفق] [❌ ناموفق]
|
||||
```
|
||||
|
||||
### تطبیق با داکیومنت:
|
||||
- فایل: `totalDoc/CMS/network-club-commission-system-v1.1.md`
|
||||
- وضعیت: [✅ تطبیق کامل] [⚠️ نیاز به بهروزرسانی] [❌ عدم تطبیق]
|
||||
- توضیحات: _________________
|
||||
|
||||
---
|
||||
|
||||
## 🏆 بیزینس 3: سطوح باشگاه
|
||||
|
||||
### بررسی کد:
|
||||
```bash
|
||||
cd CMS/src/CMSMicroservice.Domain/Entities
|
||||
grep -A 10 "ClubLevel" ClubMembership.cs
|
||||
```
|
||||
|
||||
### نتیجه:
|
||||
- [ ] ✅ 4 سطح: Bronze, Silver, Gold, Platinum
|
||||
- [ ] ✅ شرط ارتقا پیادهسازی شده
|
||||
- [ ] ✅ سطح پایین نمیآید
|
||||
- [ ] ✅ Duration (ماهانه/سالانه)
|
||||
|
||||
### تست عملی:
|
||||
```
|
||||
User: TestUser2
|
||||
PV فعلی: 5000 (Bronze)
|
||||
شرط Silver: 10000 PV
|
||||
|
||||
بعد از رسیدن به 10000:
|
||||
- سطح فعلی: _______
|
||||
- انتظار: Silver
|
||||
|
||||
نتیجه: [✅ موفق] [❌ ناموفق]
|
||||
```
|
||||
|
||||
### تطبیق با داکیومنت:
|
||||
- فایل: `totalDoc/CMS/network-club-commission-system-v1.1.md`
|
||||
- وضعیت: [✅ تطبیق کامل] [⚠️ نیاز به بهروزرسانی] [❌ عدم تطبیق]
|
||||
- توضیحات: _________________
|
||||
|
||||
---
|
||||
|
||||
## 💳 بیزینس 4: برداشت (Withdrawal)
|
||||
|
||||
### بررسی کد:
|
||||
```bash
|
||||
cd CMS/src/CMSMicroservice.Application/WithdrawalCQ
|
||||
ls -1 *Command.cs
|
||||
```
|
||||
|
||||
### نتیجه:
|
||||
- [ ] ✅ حداقل موجودی چک میشود
|
||||
- [ ] ✅ کارمزد محاسبه میشود
|
||||
- [ ] ✅ وضعیتها: Pending/Approved/Rejected
|
||||
- [ ] ✅ فقط مدیر میتواند تأیید کند
|
||||
- [ ] ✅ واریز بعد از Approve
|
||||
|
||||
### تست عملی:
|
||||
```
|
||||
موجودی: 200,000
|
||||
درخواست برداشت: 150,000
|
||||
کارمزد 2%: 3,000
|
||||
مبلغ نهایی: 147,000
|
||||
|
||||
نتیجه: [✅ موفق] [❌ ناموفق]
|
||||
```
|
||||
|
||||
### تطبیق با داکیومنت:
|
||||
- فایل: `totalDoc/CMS/implementation-progress.md`
|
||||
- وضعیت: [✅ تطبیق کامل] [⚠️ نیاز به بهروزرسانی] [❌ عدم تطبیق]
|
||||
- توضیحات: _________________
|
||||
|
||||
---
|
||||
|
||||
## 📧 بیزینس 5: اطلاعرسانی (Email/SMS)
|
||||
|
||||
### بررسی کد:
|
||||
```bash
|
||||
cd CMS/src/CMSMicroservice.Application/Common/Services
|
||||
ls -1 *Notification*
|
||||
```
|
||||
|
||||
### نتیجه:
|
||||
- [ ] ✅ Email برای Commission ارسال میشود
|
||||
- [ ] ✅ SMS برای تأیید موبایل
|
||||
- [ ] ✅ Template های HTML
|
||||
- [ ] ✅ ارسال بلافاصله بعد از event
|
||||
|
||||
### تست عملی:
|
||||
```
|
||||
Event: Commission Calculated
|
||||
User Email: test@example.com
|
||||
|
||||
Email دریافت شد؟ [✅ بله] [❌ خیر]
|
||||
محتوای Email صحیح؟ [✅ بله] [❌ خیر]
|
||||
|
||||
نتیجه: [✅ موفق] [❌ ناموفق]
|
||||
```
|
||||
|
||||
### تطبیق با داکیومنت:
|
||||
- فایل: `totalDoc/CMS/email-sms-configuration-guide.md`
|
||||
- وضعیت: [✅ تطبیق کامل] [⚠️ نیاز به بهروزرسانی] [❌ عدم تطبیق]
|
||||
- توضیحات: _________________
|
||||
|
||||
---
|
||||
|
||||
## 🛒 بیزینس 6: سفارش و فاکتور
|
||||
|
||||
### بررسی کد:
|
||||
```bash
|
||||
cd CMS/src/CMSMicroservice.Domain/Entities
|
||||
grep -A 20 "class UserOrder" UserOrder.cs
|
||||
```
|
||||
|
||||
### نتیجه:
|
||||
- [ ] ✅ UserOrder و FactorDetail
|
||||
- [ ] ✅ محاسبه PV
|
||||
- [ ] ✅ وضعیت سفارش
|
||||
- [ ] ✅ VatPercentage اضافه شده
|
||||
|
||||
### تست عملی:
|
||||
```
|
||||
محصول 1: قیمت 100,000، PV: 50
|
||||
محصول 2: قیمت 200,000، PV: 100
|
||||
|
||||
جمع PV: _______
|
||||
انتظار: 150
|
||||
|
||||
VAT 10%: _______
|
||||
انتظار: 30,000
|
||||
|
||||
نتیجه: [✅ موفق] [❌ ناموفق]
|
||||
```
|
||||
|
||||
### تطبیق با داکیومنت:
|
||||
- فایل: `totalDoc/CMS/network-club-commission-system-v1.1.md`
|
||||
- وضعیت: [✅ تطبیق کامل] [⚠️ نیاز به بهروزرسانی] [❌ عدم تطبیق]
|
||||
- توضیحات: _________________
|
||||
|
||||
---
|
||||
|
||||
## 📊 خلاصه نتایج
|
||||
|
||||
### آمار کلی:
|
||||
- تعداد بیزینس بررسی شده: 6
|
||||
- تطبیق کامل: _____ (___%)
|
||||
- نیاز به بهروزرسانی داکیومنت: _____
|
||||
- عدم تطبیق (Bug): _____
|
||||
|
||||
### موارد نیازمند اقدام فوری:
|
||||
1. _________________
|
||||
2. _________________
|
||||
3. _________________
|
||||
|
||||
### موارد نیازمند بهروزرسانی داکیومنت:
|
||||
1. _________________
|
||||
2. _________________
|
||||
3. _________________
|
||||
|
||||
---
|
||||
|
||||
## 🎯 اقدامات بعدی
|
||||
|
||||
### این هفته:
|
||||
- [ ] _________________
|
||||
- [ ] _________________
|
||||
|
||||
### ماه آینده:
|
||||
- [ ] _________________
|
||||
- [ ] _________________
|
||||
|
||||
---
|
||||
|
||||
**امضا**: _________
|
||||
**تاریخ تکمیل گزارش**: _________
|
||||
Reference in New Issue
Block a user