Веб-приложение для управления устройствами и ИИ-ментора на Raspberry Pi

Современная веб-платформа для управления устройствами, документации и идентификации оборудования с помощью искусственного интеллекта. Проект специально разработан для работы на Raspberry Pi в локальной сети.

---

📖 Оглавление

• 🚀 Особенности
• 🛠 Технологический стек
• 📦 Требования и зависимости
• 🔧 Установка и запуск
• 📜 Доступные скрипты
• 📂 Структура проекта
• 🌐 Деплой и CI/CD
• 🤝 Контрибуция
• 📄 Лицензия

---

🚀 Особенности

• Документация по устройствам: Полная база данных руководств и SCPI-команд.
• ИИ-Ментор: Идентификация оборудования по фотографии для быстрого доступа к документации.
• Пульт управления: Интерактивный интерфейс для отправки команд на устройства через Raspberry Pi.
• Real-time взаимодействие: Использование WebSockets для мгновенного обновления статусов.
• Локальная автономность: Работает без интернета в локальной Wi-Fi сети Raspberry Pi.

---

📸 Демо

Интерфейс системы управления и документации

---

🛠 Технологический стек

• Frontend: React 19, Vite 7
• Backend: Node.js, Express
• База данных: MongoDB (через Mongoose)
• Стилизация: SASS, CSS Modules
• Real-time: WS (WebSockets)
• Роутинг: React Router 7
• Линтинг: ESLint 9

---

📦 Требования и зависимости

Для запуска проекта вам потребуются:

• Node.js: версия 22.x или выше
• npm: версия 10.x или выше
• MongoDB: локальный экземпляр или доступ к Atlas

---

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

1. Клонирование репозитория

   git clone https://github.com/your-username/documentation.git
   cd documentation

2. Установка зависимостей

   npm install

3. Настройка окружения Создайте файл .env в корне проекта (если требуется) для параметров подключения к БД.

4. Запуск в режиме разработки

   npm run dev

   Приложение будет доступно по адресу http://localhost:5173

---

📜 Доступные скрипты

• npm run dev — Запуск клиента и сервера одновременно (через concurrently).
• npm run build — Сборка фронтенда для продакшена в папку dist.
• npm run lint — Проверка кода линтером ESLint.
• npm run preview — Предпросмотр собранного проекта.
• npm run start — Запуск только серверной части.

---

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

documentation/
├── backend/            # Серверная логика (Express, Mongoose)
├── src/                # Исходный код фронтенда
│   ├── components/     # Общие UI компоненты
│   ├── features/       # Функциональные модули (Network, etc.)
│   ├── pages/          # Страницы приложения
│   ├── style/          # Глобальные стили (SASS)
│   └── main.jsx        # Точка входа React
├── public/             # Статические ресурсы
├── .github/            # Настройки CI/CD (GitHub Actions)
├── vite.config.js      # Конфигурация Vite
└── package.json        # Зависимости и скрипты

---

🌐 Деплой и CI/CD

Проект использует GitHub Actions для автоматизации процессов:

• CI: При каждом пуше в ветку web-servis выполняется проверка линтером и сборка.
• CD: После успешной сборки триггерит деплой на Render через Webhook.

---

🤝 Контрибуция

Будем рады вашему участию! Порядок действий:

1. Сделайте Fork проекта.
2. Создайте ветку (git checkout -b feature/NewFeature).
3. Закоммитьте изменения (git commit -m 'Add some NewFeature').
4. Отправьте ветку (git push origin feature/NewFeature).
5. Откройте Pull Request.

---

📄 Лицензия

Этот проект лицензирован под MIT License — подробности в файле LICENSE.

---

Сделано с ❤️ для разработчиков и инженеров.