Skip to main content

Добро пожаловать в документацию Lowcode Platform

Добро пожаловать в официальную документацию монорепозитория Lowcode Platform — системы для создания веб‑ и desktop‑приложений без написания кода. Здесь вы найдёте подробные описания архитектуры, внутренних модулей, фреймворков, а также практические руководства для разработчиков.

🎯 Цели документации​

Эта документация создана для того, чтобы:

  • дать целостное понимание архитектуры Lowcode Platform;
  • объяснить, как взаимодействуют модули @lowcode/api, @lowcode/builder-web, @lowcode/dsl-compiler и runtime-host;
  • описать используемые фреймворки (NestJS, Fastify, Prisma, Vite, Turborepo, Docker) простым и понятным языком;
  • предоставить справочную информацию по классам, типам и структурам данных (автогенерация Typedoc);
  • дать готовые гайды по разработке новых функций.

🧱 Структура документации​

Документация разделена на несколько основных блоков:

1. Архитектура платформы​

Раздел описывает общую структуру системы, роли модулей, потоки данных, жизненный цикл приложения и ключевые технические решения.

2. Фреймворки и инфраструктура​

Подробные, но компактные обзоры используемых технологий:

  • NestJS + Fastify
  • Prisma
  • Vite + React
  • Turborepo + pnpm
  • Docker

Каждый обзор сопровождается минимальными примероми и привязкой к структуре репозитория.

3. Руководства (Guides)​

Практические пошаговые инструкции:

  • как запустить проект локально;
  • как добавить новый REST‑эндпоинт в API;
  • как расширить DSL или добавить новый блок;
  • как собрать и развернуть платформу.

4. Справочник (Reference)​

Автоматически генерируемые Typedoc‑страницы по:

  • @lowcode/api
  • @lowcode/builder-web
  • @lowcode/dsl-compiler

Этот раздел обновляется автоматически при сборке документации.

🚀 Быстрый старт​

Если вы впервые открыли этот проект:

  1. Перейдите в раздел Фреймворки, чтобы понять, как устроены ключевые технологии.
  2. Затем откройте Архитектуру, чтобы увидеть, как эти технологии взаимодействуют.
  3. После этого посмотрите Guides, чтобы попробовать запустить или расширить проект.

🧩 О проекте​

Lowcode Platform — это монорепозиторий, содержащий:

  • визуальный UI‑редактор (builder‑web);
  • API‑сервер на NestJS (apps/api);
  • DSL‑компилятор и валидатор (packages/dsl-compiler);
  • хостинг и рантайм‑окружение для сгенерированных приложений;
  • общие типы и утилиты (packages/shared-types);
  • сайт документации (apps/docs).

Платформа позволяет создавать приложения из компонентов, описанных DSL‑деревом, валидировать структуру проекта, компилировать его в React‑бандл и выполнять внутри runtime‑хоста.

📚 Обратная связь​

Если вы нашли опечатку, хотите улучшить структуру или добавить новый раздел — создавайте PR или сообщайте в обсуждении проекта.

Добро пожаловать в разработку Lowcode Platform!