MahdiandCursor
40d492cb5a
Rewrite roadmap and progress for the shipped product, update the user guide for auth/Tahesab/AI/UI, and add a short feature index. Co-authored-by: Cursor <cursoragent@cursor.com>
99 lines
3.0 KiB
Markdown
99 lines
3.0 KiB
Markdown
# Mento CRM (منتو)
|
||
|
||
Monorepo برای CRM فروش‌محور ایرانی با هم‌ترازی قابلیت نسبت به دیدار، به‌اضافه Smart Notes (سند کارفرما).
|
||
|
||
## استک
|
||
|
||
| بخش | فناوری |
|
||
|---|---|
|
||
| پنل | Vue 3 + Vite + TypeScript + Pinia |
|
||
| API | NestJS |
|
||
| دیتابیس | PostgreSQL (Prisma) |
|
||
| صف/کش | Redis (آماده در Compose) |
|
||
| فایل | MinIO (آماده در Compose) |
|
||
| لندینگ | بعداً با Nuxt در `apps/landing` |
|
||
|
||
UI را پیکسل‌به‌پیکسل از دیدار کپی نمی‌کنیم؛ هویت بصری مستقل **منتو (Mento)** است.
|
||
|
||
## ساختار
|
||
|
||
```text
|
||
apps/
|
||
web/ # پنل Vue
|
||
api/ # NestJS
|
||
packages/
|
||
shared/ # تایپ‌ها و قرارداد مشترک
|
||
docs/ # نقشه راه و PRD
|
||
docker-compose.yml
|
||
```
|
||
|
||
## پیش‌نیاز
|
||
|
||
- Node.js 20+
|
||
- PostgreSQL روی `localhost:5432` یا Docker Desktop
|
||
- (اختیاری) Redis و MinIO از Compose
|
||
|
||
اگر Docker دارید:
|
||
|
||
```bash
|
||
docker compose up -d
|
||
```
|
||
|
||
## راه‌اندازی
|
||
|
||
```bash
|
||
npm install
|
||
npm run build -w @mento/shared
|
||
npm run prisma:generate -w @mento/api
|
||
npm run prisma:migrate -w @mento/api
|
||
npm run prisma:seed -w @mento/api
|
||
```
|
||
|
||
ترمینال ۱:
|
||
|
||
```bash
|
||
npm run dev:api
|
||
```
|
||
|
||
ترمینال ۲:
|
||
|
||
```bash
|
||
npm run dev:web
|
||
```
|
||
|
||
- پنل: http://localhost:5173
|
||
- API: http://localhost:3000/api/health
|
||
|
||
حساب دمو بعد از seed:
|
||
|
||
- مالک: `owner@demo.local` / `demo1234`
|
||
- مدیر: `admin@demo.local` / `demo1234`
|
||
- فروش: `sales@demo.local` / `demo1234`
|
||
|
||
## فاز فعلی
|
||
|
||
فاز ۱ هسته فروش/پشتیبانی و Smart Notes عملاً کامل است. جزئیات تیک‌خورده و باقی‌مانده:
|
||
|
||
- [`docs/وضعیت-پیشرفت.md`](docs/وضعیت-پیشرفت.md) ← **چک‌لیست زنده**
|
||
- [`docs/قابلیت‌های-منتو.md`](docs/قابلیت‌های-منتو.md) ← فهرست کوتاه قابلیت‌ها
|
||
- [`docs/راهنما-و-نقشه-راه.md`](docs/راهنما-و-نقشه-راه.md) ← نقشه راه
|
||
|
||
نمونه‌های اخیر آماده‌شده: احراز هویت OTP/رمز، Ask Mento، Voice-to-Text، اتصال ته‌حساب، یادآور SMS فعالیت، UI یکدست، جداکننده مبلغ.
|
||
|
||
استقرار: [`deploy/DEPLOY.md`](deploy/DEPLOY.md) → `crm.montzar.ir`
|
||
|
||
## راهنمای کاربری
|
||
|
||
برای کار با پنل (زبان ساده، گام‌به‌گام):
|
||
|
||
- [`docs/راهنمای-کاربری.md`](docs/راهنمای-کاربری.md)
|
||
- [`docs/راهنمای-کاربری.docx`](docs/راهنمای-کاربری.docx) *(باید بعد از تغییر MD دوباره ساخته شود)*
|
||
- [`docs/راهنمای-کاربری.pdf`](docs/راهنمای-کاربری.pdf) *(باید بعد از تغییر MD دوباره ساخته شود)*
|
||
|
||
برای بازتولید Word/PDF:
|
||
|
||
```bash
|
||
python docs/export-doc.py --preset user-guide
|
||
```
|
||
|
||
سپس در صورت نیاز همان DOCX را از Word به PDF Export کنید. |