سیستم مستندات یکپارچه

داشبورد مستندات

پروژه‌ها5مسیرهای اسکن‌شده
Endpoint611استخراج از controller/router/urlconf
Data Model277Prisma/Django/Pydantic/DTO
Module101گروه‌بندی از ساختار کد

توزیع Endpointها

Mermaid pie chart

pie showData
  title Endpoint distribution
  "IOT" : 92
  "Knowledge" : 96
  "Backend Core" : 293
  "Health check" : 130
  "Documentation" : 0

توزیع مدل‌های داده

Mermaid pie chart

pie showData
  title Data model distribution
  "IOT" : 56
  "Knowledge" : 63
  "Backend Core" : 123
  "Health check" : 35
  "Documentation" : 0

داشبورد پروژه‌ها

IOT

Full-stack

Elevator IoT Intelligence Platform Investor-grade prototype for elevator fleet monitoring, realtime telemetry, alerts, analytics, and predictive-maintenance style insights. Monorepo Layout - `apps/core-backend`: NestJS platform API, ingest pipeline, websocket fanout, RBAC - `apps/simulation-backend`: FastAPI + SimPy simulation engine and fake data generation - `apps/web-frontend`: Next.js bilingual dashboard (English + Persian) with RTL/LTR support - `packages/shared-contracts`: shared message contracts for simulation and ingest - `docs`: architecture, domain, localization, realtime, simulation, analytics, roadmap Current Scope - Core backend with modular APIs for auth, fleet entities, telemetry/events/faults, analytics, alerts, tickets, service visits, technicians, catalogs, reports, simulation-control, audit and settings

مشاهده توضیحات کامل فارسی / English

خلاصه فارسی

پروژه IOT لایه عملیاتی برای دریافت، پایش و تحلیل داده‌های دستگاه‌ها، رخدادها و وضعیت‌های میدانی است. تمرکز اصلی آن روی ingest مطمئن، نگهداری وضعیت تجهیزات، تبدیل telemetry خام به اطلاعات قابل تصمیم‌گیری و آماده‌سازی خروجی برای داشبوردها، هشدارها و سرویس‌های پایین‌دستی است.

English Overview

The IOT project acts as the operational telemetry layer for device data, field events, status tracking, and downstream monitoring workflows. Its main responsibility is to receive raw signals, normalize them, preserve device state, and expose reliable operational data for dashboards, alerts, automation, and business reporting.

Business Scope

  • پایش وضعیت دستگاه‌ها و رخدادهای میدانی
  • ثبت و تحلیل fault، alert و telemetry
  • آماده‌سازی داده برای گزارش عملیاتی و تصمیم‌گیری
  • پشتیبانی از فرایندهای نگهداری، عیب‌یابی و واکنش سریع

Technical Scope

  • مرزبندی ingest، پردازش رخداد و persistence
  • مدل‌سازی device/event/state و routeهای مرتبط
  • نیاز به idempotency، validation و کنترل حجم داده
  • اتصال احتمالی به queue، cache، database و سرویس‌های notification

Handoff Notes

در handoff این پروژه باید قرارداد payload دستگاه، lifecycle رخداد، ساختار topic/queue، سیاست retry، retention داده و mapping هشدارها با سناریوهای بیزینسی مشخص باشد.

Frameworks
NestJS, Next.js, FastAPI
Languages
Python, TypeScript, JavaScript, SQL
Business docs
17
Tests
22
فایل‌ها
290
ماژول‌ها
32
API
92
مدل‌ها
56
DockerFastAPIJavaScriptNestJSNext.jsPlaywrightPostgreSQLPrisma
مشاهده مستندات پروژه

Knowledge

Full-stack

Elevator Bible Elevator Bible is a domain-specific knowledge operating system for elevator technicians, trainers, and technical managers. This repository bootstraps the first production-minded slice of the platform around: - core domain models and taxonomy - source registry and review workflow primitives - Persian PDF exam ingestion for training-question extraction - FastAPI skeleton for taxonomy, search, troubleshooting, and import preview - offline knowledge-pack export to SQLite Quick Start ```powershell python -m pip install -e .[dev]

مشاهده توضیحات کامل فارسی / English

خلاصه فارسی

پروژه Knowledge نقش مرکز مدیریت دانش و محتوای قابل جستجو را دارد. این پروژه برای جمع‌آوری، دسته‌بندی، غنی‌سازی و بازیابی دانش سازمانی یا محصولی استفاده می‌شود و باید بین محتوا، taxonomy، جستجو، review و مصرف‌کننده‌های نهایی یک جریان قابل اتکا ایجاد کند.

English Overview

The Knowledge project is the knowledge management and retrieval layer. It organizes source material, taxonomy, searchable content, review workflows, and user-facing discovery so teams can turn scattered documents and business knowledge into structured, reusable information.

Business Scope

  • تجمیع مستندات و دانش پراکنده
  • قابل جستجو کردن محتوا برای تیم‌های فنی و بیزینسی
  • پشتیبانی از review، دسته‌بندی و به‌روزرسانی محتوا
  • کاهش زمان یافتن پاسخ و تصمیم‌گیری بر اساس دانش معتبر

Technical Scope

  • ساختاردهی source، parser، index و taxonomy
  • ارتباط محتوا با metadata، tag و version
  • نیاز به کنترل کیفیت داده، deduplication و freshness
  • آمادگی برای اتصال به search engine یا assistant layer

Handoff Notes

در handoff این پروژه باید نوع منابع ورودی، schema metadata، چرخه تایید محتوا، سطح دسترسی، strategy ایندکس و قواعد حذف/به‌روزرسانی دانش ثبت شود.

Frameworks
Next.js, FastAPI
Languages
Python, TypeScript, JavaScript
Business docs
15
Tests
13
فایل‌ها
207
ماژول‌ها
4
API
96
مدل‌ها
63
FastAPIJavaScriptNext.jsPythonTypeScriptpytest
مشاهده مستندات پروژه

Backend Core

Backend / Service

در کد منبع README مستقیمی برای خلاصه پروژه پیدا نشد.

مشاهده توضیحات کامل فارسی / English

خلاصه فارسی

Backend Core ستون اصلی سرویس‌های سمت سرور است و مسئول APIها، مدل‌های داده، auth، منطق دامنه، orchestration و قراردادهای مشترک بین پروژه‌هاست. این پروژه بیشترین اثر را روی پایداری، امنیت، توسعه‌پذیری و یکپارچگی داده‌های سیستم دارد.

English Overview

Backend Core is the central server-side foundation. It owns APIs, domain models, authentication boundaries, shared business rules, orchestration, and cross-project contracts. Changes here have broad impact on stability, security, data consistency, and integration behavior.

Business Scope

  • ارائه APIهای اصلی برای کلاینت‌ها و سرویس‌ها
  • نگهداری منطق دامنه و قوانین مشترک
  • مدیریت کاربران، دسترسی‌ها و جریان‌های اصلی سیستم
  • پشتیبانی از گزارش، عملیات، تنظیمات و داده‌های اصلی

Technical Scope

  • route/controller/service/model boundaries
  • auth، authorization، validation و audit trail
  • مدیریت database schema، migration و data contract
  • نیاز به تست contract، monitoring و backward compatibility

Handoff Notes

در handoff این پروژه باید مالکیت هر endpoint، مدل داده، policy دسترسی، side effectها، dependencyهای خارجی، migrationها و قراردادهای شکست/خطا مستند شود.

Frameworks
Django, Django REST Framework
Languages
Python
Business docs
0
Tests
11
فایل‌ها
414
ماژول‌ها
36
API
293
مدل‌ها
123
DRFDjangoDockerPythonRedispytest
مشاهده مستندات پروژه

Health check

Full-stack

iava iava is a production-oriented MVP for cyberpunk-style QA management and test monitoring. It includes a NestJS API, Vue 3 panel, PostgreSQL, Prisma migrations, JWT auth with refresh rotation, RBAC, scheduled checks, audit logs, and Docker Compose local development. Run With Docker ```bash docker compose up --build ``` Open: - Web app: http://localhost:5173 - API: http://localhost:3000/api - Swagger: http://localhost:3000/api/docs

مشاهده توضیحات کامل فارسی / English

خلاصه فارسی

Health check پروژه پایش سلامت سرویس‌ها، دامنه‌ها، سرورها و سناریوهای عملیاتی است. هدف آن شناسایی زودهنگام خرابی، اندازه‌گیری latency و availability، ایجاد تاریخچه اجرا و ارسال هشدار قابل پیگیری برای تیم‌های مسئول است.

English Overview

The Health check project provides service and infrastructure monitoring. It tracks availability, latency, scenario execution, failure history, and notification workflows so operations teams can detect problems early and respond with clear context.

Business Scope

  • تعریف پروژه، عضو، دامنه، سرور و سناریوی تست
  • اجرای چک‌های دوره‌ای یا دستی
  • نمایش وضعیت سلامت، خرابی و latency
  • ارسال notification و فراهم کردن audit/history برای پیگیری

Technical Scope

  • scheduler، runner، check execution و result persistence
  • مدل‌های project/member/check/server/scenario/history
  • نیاز به retry، timeout، rate limit و alert deduplication
  • اتصال به email، SMS، webhook یا کانال‌های اطلاع‌رسانی

Handoff Notes

در handoff این پروژه باید فرکانس چک‌ها، thresholdها، سیاست alert، owner هر پروژه، retention history و رفتار سیستم در outage یا failure زنجیره‌ای مشخص شود.

Frameworks
NestJS, Vue
Languages
TypeScript, JavaScript, Vue, SQL
Business docs
11
Tests
2
فایل‌ها
135
ماژول‌ها
28
API
130
مدل‌ها
35
DockerJavaScriptJestNestJSPrismaSQLTypeScriptVue
مشاهده مستندات پروژه

Documentation

Library / Tooling

مستندات پروژه‌ها این پوشه شامل سیستم مستندات استاتیک تولیدشده از کد پروژه‌های محلی است. استفاده فایل `index.html` را در مرورگر باز کنید. اگر token محلی وجود نداشته باشد به `login.html` هدایت می‌شوید. بازتولید ```powershell python .\generator\generate-docs.py ``` Mermaid به صورت local از `assets/js/vendor/mermaid.min.js` بارگذاری می‌شود و برای نمودارها، ERD و چارت‌های داشبورد استفاده شده است. افزودن پروژه جدید

مشاهده توضیحات کامل فارسی / English

خلاصه فارسی

Documentation خودش یک پروژه مستقل برای تولید، نمایش و نگهداری مستندات فنی و بیزینسی است. این پروژه کد پروژه‌های دیگر را به صورت read-only اسکن می‌کند، صفحات HTML، search index، manifest و دیاگرام‌های Mermaid را می‌سازد و یک UI قابل استفاده برای تحویل دانش پروژه فراهم می‌کند.

English Overview

Documentation is a standalone static documentation product. It scans the other projects in read-only mode, generates HTML pages, manifest files, search indexes, Mermaid diagrams, and a guarded UI that makes technical and business handoff material easier to browse.

Business Scope

  • تبدیل ساختار کد و فایل‌های handoff به مستندات قابل مرور
  • ایجاد دید مشترک برای تیم فنی، QA، DevOps و محصول
  • پشتیبانی از جستجوی سراسری، نمودارها و صفحات پروژه‌ای
  • کاهش وابستگی به توضیحات شفاهی و فایل‌های پراکنده

Technical Scope

  • generator پایتونی برای scan و تولید خروجی static
  • auth محلی، search-index، Mermaid rendering و modal fullscreen
  • ساختار assets، projects، shared و manifest
  • نیاز به بازتولید خروجی بعد از تغییرات generator یا پروژه‌ها

Handoff Notes

در handoff این پروژه باید روش regenerate، محدوده scan، فایل‌های خروجی، login محلی، قرارداد Mermaid و محدودیت‌های offline/static بودن توضیح داده شود.

Frameworks
نیازمند بررسی انسانی
Languages
Python, JavaScript
Business docs
1
Tests
0
فایل‌ها
16
ماژول‌ها
1
API
0
مدل‌ها
0
JavaScriptPython
مشاهده مستندات پروژه