VK Content Planner (React + Python Backend)

Это фронтенд-приложение на React для планирования и управления контентом в сообществах ВКонтакте. Оно взаимодействует с бэкендом на Python (FastAPI) для выполнения всех операций.

Запуск проекта

Проект состоит из двух частей: фронтенд на React и бэкенд на Python.

1. Настройка и запуск бэкенда

Все инструкции по настройке и запуску Python-бэкенда находятся в файле backend_python/README.md.txt.

Кратко (для локальной разработки):

1. Перейдите в папку backend_python.
2. Убедитесь, что все файлы .py.txt и README.md.txt переименованы в .py и .md соответственно.
3. Создайте виртуальное окружение и установите зависимости: pip install -r requirements.txt.
4. Создайте файл .env на основе .env.example и впишите свои токены.
5. Запустите сервер: uvicorn main:app --reload.

2. Запуск фронтенда

1. Настройте URL бэкенда:

   • На странице входа в приложение доступен переключатель "Окружение API" с тремя режимами:
     • Продакшен: Использует "боевой" сервер, развернутый в Yandex.Cloud.
     • Предпродакшен: Использует тестовый ("staging") сервер, развернутый в Yandex.Cloud.
     • Локальный: Использует ваш локальный бэкенд, запущенный по адресу http://127.0.0.1:8000.
   • Выбор сохраняется в localStorage и применяется после перезагрузки страницы.

2. Запустите сервер для разработки фронтенда:

   • Откройте терминал в корневой папке проекта.
   • Выполните команду npm install (если вы делаете это в первый раз).
   • Выполните команду npm run dev.
   • Откройте в браузере адрес, который покажет Vite (обычно http://localhost:5173).

Аутентификация

При первом входе в приложение потребуется авторизация.

• Администратор:

  • Логин по умолчанию: admin
  • Пароль по умолчанию: admin
  • Эти данные настраиваются в файле backend_python/.env через переменные ADMIN_USERNAME и ADMIN_PASSWORD.
  • Администратор имеет доступ ко всем функциям, включая управление пользователями и базой данных проектов.

• Пользователь:

  • Учетные данные создаются администратором на странице "Управление пользователями".
  • Пользователь имеет доступ ко всем основным функциям (просмотр расписания, создание постов), но не может управлять пользователями и проектами.

Структура проекта

• features/: Исходный код фронтенд-приложения на React (Feature-Sliced Design).
• shared/: Общие компоненты, хуки и утилиты.
• services/: API-клиенты и сервисы.
• hooks/: Глобальные хуки приложения.
• backend_python/: Исходный код бэкенда на Python/FastAPI.
• docs/: Техническая документация проекта:
  • docs/frontend/: Документация по архитектуре фронтенда.
  • docs/backend/: Документация по архитектуре бэкенда.
  • docs/api/: API контракт и схема базы данных.
  • docs/ui-kit/: Документация по визуальным компонентам.
  • docs/architecture/: Общая архитектурная документация.
• getstoris/: Отдельный сервис для работы со сторис.
• vk-review-automation-concept/: Концепт автоматизации отзывов.