web/readme.md

2.5 KiB
Raw Permalink Blame History

🧠 Data Helper

Простой и удобный инструмент для работы с данными, интеграцией с CAD-системами и автоматизацией бизнес-процессов.


🔍 Описание

Это универсальный внутренний инструмент компании, позволяющий:

  • Работать с данными из КОМПАС-3Д.
  • Экспортировать спецификации в CRM/ERP.
  • Автоматизировать процессы между отделами (инженеры, маркетологи, IT).
  • Упрощать работу с формами, базами данных и отчетами.

📦 Требования

  • Docker и Docker Compose
  • Python 3.11+ (для локального запуска бэкенда)
  • Node.js + npm (для локального запуска фронта)
  • PostgreSQL (в Docker или на сервере)
  • Redis (в Docker)

▶️ Установка и запуск

🐳 Через Docker

Запустите проект через Docker Compose:

docker compose -f compose.yaml -f compose.db.yaml up --build

Сайт будет доступен по адресу:

http://localhost:${WEB_PORT:-80}

🔌 Примонтирование .env в контейнеры

Создайте символические ссылки на общий .env:

ln -s ~/projects/data-helper/.env ~/projects/data-helper/app/.env
ln -s ~/projects/data-helper/.env ~/projects/data-helper/front/.env

Это обеспечит единое окружение для бэкенда и фронтенда.

💻 Локальный запуск бэкенда

Если вы хотите запускать бэкенд локально:

cd app
REDIS_NAME='localhost' poetry run python manage.py runserver

Бэкенд будет доступен на http://localhost:8000.

🌐 Локальный запуск фронтенда

Для локальной разработки фронтенда:

cd front
npm run dev

Фронт будет доступен на http://localhost:3000.

⚙️ Конфигурация

Настройте параметры в .env:

# Порт веб-приложения
WEB_PORT=8000
CELERY_PORT=8001
# База данных
DB_NAME=datahelper
DB_USER=admin
DB_PASSWORD=secret
DB_HOST=localhost
DB_PORT=5432

# Redis
# REDIS_NAME=localhost