Lawyer_AI

0

Описание

Языки

  • Python63%
  • JavaScript20,8%
  • CSS14,3%
  • HTML1,9%
K
KOTO
08 окт 2025, 18:57
readme
Конечно! Вот готовый файл `README.md` для твоего фронтенда — чёткий, профессиональный и понятный для любого разработчика.
 
---
 
```markdown
# Юридический чат на React
 
Веб-интерфейс для взаимодействия с нейросетевым юридическим помощником на базе GigaChat.
Фронтенд реализован как SPA (Single Page Application) с поддержкой темной/светлой темы, лайков и отзывчивого дизайна.
 
![Скриншот интерфейса](screenshot.png) *(опционально)*
 
## 🚀 Возможности
 
- Отправка текстовых вопросов по юридической тематике
- Отображение ответов от бэкенда (GigaChat)
- Переключение между светлой и тёмной темой (настройки сохраняются)
- Оценка ответов: 👍 / 👎
- Полная адаптация под мобильные устройства
- Чистый CSS, без фреймворков стилей
 
## 🛠 Технологии
 
- **Frontend**: React + Vite
- **Стили**: Чистый CSS (без Tailwind, Bootstrap и т.п.)
- **Язык**: JavaScript (ES6+)
- **Сборка**: Vite
- **Деплой**: Поддержка Vercel, Netlify, GitHub Pages
 
## 📦 Установка и запуск
 
1. Убедитесь, что установлен [Node.js](https://nodejs.org/) (версия 18+)
 
2. Клонируйте репозиторий и перейдите в папку проекта:
```bash
git clone <ваш-репозиторий>
cd legal-chat-frontend
```
 
3. Установите зависимости:
```bash
npm install
```
 
4. Запустите локальный сервер:
```bash
npm run dev
```
 
5. Откройте в браузере:
👉 [http://localhost:5173](http://localhost:5173)
 
## ⚙️ Настройка подключения к бэкенду
 
По умолчанию фронтенд обращается к бэкенду по адресу:
 
```js
http://localhost:8000/ask
```
 
Чтобы изменить URL (например, при деплое), отредактируйте файл:
 
```
src/hooks/useChat.js
```
 
Найдите строку:
```js
const API_URL = 'http://localhost:8000/ask';
```
 
И замените её на актуальный адрес вашего бэкенда:
```js
const API_URL = 'https://ваш-бэкенд.домен/ask';
```
 
> 💡 Убедитесь, что бэкенд поддерживает CORS для origin `http://localhost:5173` (в разработке) и вашего домена (в продакшене).
 
## 📤 Деплой
 
Проект готов к деплою на любую статическую хостинг-платформу:
 
### Vercel / Netlify
1. Подключите репозиторий
2. Укажите команду сборки: `npm run build`
3. Выходная директория: `dist`
 
### GitHub Pages
```bash
npm run build
npx gh-pages -d dist
```
 
## 📁 Структура проекта
 
```
src/
├── components/ # Компоненты чата (сообщения, инпут, переключатель темы)
├── hooks/ # Кастомный хук useChat для работы с API
├── App.jsx # Корневой компонент
├── main.jsx # Точка входа
└── index.css # Глобальные стили + темы
```
 
## 📝 Лицензия
 
Проект распространяется по лицензии MIT. См. файл `LICENSE` для подробностей.
 
---
 
Разработано для проекта **Lawyer_AI**
Backend: [https://gitverse.ru/KOTO/Lawyer_AI](https://gitverse.ru/KOTO/Lawyer_AI)
```
 
---
 
💡 **Совет**:
- Добавь скриншот интерфейса в корень проекта (`screenshot.png`) — так README будет выглядеть ещё лучше.
- Если используешь GitHub/GitLab — этот README автоматически отобразится на главной странице репозитория.
 
Хочешь версию на английском или с логотипом? Готов доработать!