From 39d9d9cd7a84d4423dee4923004e05b9382e0508 Mon Sep 17 00:00:00 2001 From: DCCONSTRUCTIONS Date: Sat, 18 Apr 2026 19:23:01 +0300 Subject: [PATCH] Add root README for NODE.DC TM --- README.md | 121 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 121 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..8e04bca --- /dev/null +++ b/README.md @@ -0,0 +1,121 @@ +# NODE.DC TM + +Локальный self-hosted стенд `NODE.DC TM` для разработки, кастомизации и переноса на другие машины. + +В репозитории уже лежит полный рабочий контур: +- исходники: `plane-src/` +- runtime и compose: `plane-app/` +- сценарий запуска: `setup.sh` +- рабочий env: `plane-app/plane.env` +- snapshot данных: `plane-app/backup/20260418-1904/` +- техническая документация: `README_RUN_RU.md` +- архитектурный обзор: `ARCH_REVIEW_NODEDC_RU.md` + +## Быстрый старт + +Требования: +- macOS или Linux +- Docker Desktop / Docker Engine +- Docker Compose + +Запуск: + +```bash +cd /Users/dcconstructions/Downloads/mnt/data/dc_taskmanager/NODEDC_TASKMANAGER +./setup.sh start +``` + +Остановка: + +```bash +cd /Users/dcconstructions/Downloads/mnt/data/dc_taskmanager/NODEDC_TASKMANAGER +./setup.sh stop +``` + +Перезапуск: + +```bash +cd /Users/dcconstructions/Downloads/mnt/data/dc_taskmanager/NODEDC_TASKMANAGER +./setup.sh restart +``` + +Локальный доступ: +- `http://localhost:8090` + +## Структура проекта + +- `plane-src/` — исходники фронта, backend и пакетов +- `plane-app/` — runtime-конфиг, compose, env, backup данных +- `scripts/` — служебные сценарии и bootstrap +- `demo-assets/` — демо-файлы и бренд-материалы +- `README_RUN_RU.md` — подробная инструкция эксплуатации +- `ARCH_REVIEW_NODEDC_RU.md` — прикладной технический обзор + +## Сборка локальных образов + +Если менялись исходники, образы пересобираются так: + +```bash +cd /Users/dcconstructions/Downloads/mnt/data/dc_taskmanager/NODEDC_TASKMANAGER/plane-src/apps/api +docker build -t nodedc/plane-backend:local -f Dockerfile.api . + +cd /Users/dcconstructions/Downloads/mnt/data/dc_taskmanager/NODEDC_TASKMANAGER/plane-src +docker build -t nodedc/plane-frontend:ru -f apps/web/Dockerfile.web . +docker build -t nodedc/plane-admin:ru -f apps/admin/Dockerfile.admin . +docker build -t nodedc/plane-space:ru -f apps/space/Dockerfile.space . +``` + +После пересборки: + +```bash +cd /Users/dcconstructions/Downloads/mnt/data/dc_taskmanager/NODEDC_TASKMANAGER +./setup.sh stop +./setup.sh start +``` + +## Логи + +```bash +cd /Users/dcconstructions/Downloads/mnt/data/dc_taskmanager/NODEDC_TASKMANAGER +./setup.sh logs api +./setup.sh logs worker +./setup.sh logs web +./setup.sh logs admin +./setup.sh logs space +./setup.sh logs proxy +``` + +## Что хранится в репозитории + +В репозитории уже сохранены: +- кодовая база +- runtime-конфиг +- рабочий `plane.env` +- snapshot volume-данных + +То есть с другой машины можно: +1. клонировать репозиторий +2. поднять сервисы +3. при необходимости восстановить данные из `plane-app/backup/20260418-1904/` + +## Восстановление стенда + +Минимальный сценарий: + +```bash +git clone +cd NODEDC_TASKMANAGER +./setup.sh start +``` + +Если нужен именно текущий снимок данных, используй архивы из: + +```bash +plane-app/backup/20260418-1904/ +``` + +Подробный регламент запуска, обслуживания и наполнения: +- `README_RUN_RU.md` + +Технический обзор структуры и точек кастомизации: +- `ARCH_REVIEW_NODEDC_RU.md`