moex-vibe/apps/docs/docs/intro.md
Sergey Krylov aac5b2f873
All checks were successful
CI / lint (pull_request) Successful in 1m32s
CI / test (pull_request) Successful in 1m23s
CI / build (pull_request) Successful in 1m27s
CI / lint (push) Successful in 1m16s
CI / test (push) Successful in 1m23s
CI / build (push) Successful in 1m32s
docs: add Docusaurus documentation site as npm workspace
- Create apps/docs/ with Docusaurus 3.7.0
- Add documentation: architecture, backend, frontend, infrastructure, development, ADR
- Include 5 Mermaid diagrams (system architecture, request flow, modules, caching, deployment)
- Configure as npm workspace with dev:docs/build:docs scripts
- Copy existing ADR documents from docs/architecture/adr/
2026-06-13 21:37:10 +03:00

1.3 KiB
Raw Blame History

MoexVibe

Веб-приложение для анализа ценных бумаг Московской биржи (MOEX).

Tech Stack

  • Backend: NestJS, TypeScript, OpenAPI (Swagger)
  • Frontend: React 18, TypeScript, Vite, TanStack Query v5, lightweight-charts v4
  • Infrastructure: Docker, docker-compose
  • CI: Gitea Actions

Repository Structure

moex-vibe/
├── apps/
│   ├── backend/     # NestJS API (единственная точка доступа к MOEX)
│   └── frontend/    # React SPA
├── docs/
│   ├── architecture/  # ADR и диаграммы
│   ├── openapi/       # OpenAPI-спецификация
│   └── superpowers/   # Дизайн-спеки и планы
├── docker/
│   ├── Dockerfile.backend
│   ├── Dockerfile.frontend
│   └── nginx.conf
├── docker-compose.yml
└── tsconfig.base.json

Key Principles

  • Backend — единственный клиент MOEX. Frontend никогда не обращается к MOEX напрямую.
  • npm workspaces монорепозиторий: apps/backend и apps/frontend.
  • Глобальный префикс API: /api/v1. Swagger: /api/docs.
  • Ответы API обёрнуты в { data: T, meta: { fromCache, cachedAt } }.