Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
Riffaells committed Nov 4, 2024
1 parent 54fe043 commit 400968c
Showing 1 changed file with 1 addition and 84 deletions.
85 changes: 1 addition & 84 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,36 +94,11 @@ BirthdayWishes/
ffmpeg -version
```

## 🔧 Конфигурация и работа с видео

BirthdayWishes использует FFmpeg для обработки загружаемых видео, конвертируя их в формат HLS для плавной потоковой передачи.

### Пример команды для конвертации

```python
cmd = [
'ffmpeg',
'-i', input_file,
'-c:v', 'libx264',
'-c:a', 'aac',
'-ar', '48000',
'-b:a', '128k',
'-profile:v', 'baseline',
'-level', '3.1',
'-g', '60', # Устанавливает интервал между ключевыми кадрами
'-hls_time', '2', # Длительность сегмента в секундах
'-hls_list_size', '0',
'-hls_flags', 'independent_segments',
'-hls_segment_filename', os.path.join(output_dir, 'segment_%03d.ts'),
'-f', 'hls',
output_file
]
```


## 📖 API эндпоинты

- **GET /api/videos/**: Возвращает список всех видео в формате JSON.
- **POST /api/videos/upload/**: Загружает новое видео для поздравления.

### Пример ответа JSON для `/api/videos/`

Expand All @@ -140,56 +115,6 @@ cmd = [
]
```

## 🖥 Frontend функциональность

### Видео-плеер

BirthdayWishes использует **Video.js** и **HLS.js** для воспроизведения видео.

- **Перемотка**: Двойное нажатие слева или справа на плеере перематывает видео на 10 секунд вперед или назад.
- **Автоматическое переключение**: Пользователь может переключаться между видео с помощью кнопок навигации.

### Структура Frontend файлов

- **videos.html**: Главный HTML-шаблон для видео-плеера.
- **videos.js**: JavaScript файл, который инициализирует плеер и управляет воспроизведением видео.
- **videos.css**: Стили для оформления плеера и элементов управления.

## 🎨 Пользовательский интерфейс

- **Vue.js** используется для управления динамическим контентом на фронтенде.
- **CSS и стили**: Применяются стили для кнопок навигации, элементов управления плеером и адаптивной верстки.

## 📝 Пример конфигурации сервера

Для корректной работы HLS рекомендуется настроить сервер на передачу правильных MIME-типов.

### Пример конфигурации для Nginx:

```nginx
server {
listen 80;
server_name example.com;
location /media/hls/ {
add_header 'Access-Control-Allow-Origin' '*';
types {
application/vnd.apple.mpegurl m3u8;
video/mp2t ts;
}
alias /path/to/media/hls/;
}
location /static/ {
alias /path/to/static/files/;
}
location / {
proxy_pass http://127.0.0.1:8000;
}
}
```

## 📚 Полезные команды

- **Запуск сервера разработки**: `python manage.py runserver`
Expand All @@ -200,15 +125,7 @@ server {

Этот проект распространяется под лицензией MIT. Подробнее см. файл [LICENSE](LICENSE).

## 💬 Поддержка

Если у вас есть вопросы или предложения, вы можете открыть issue в репозитории проекта на GitHub.

---

🎂 **Наслаждайтесь использованием BirthdayWishes! Пусть каждый день рождения будет наполнен теплыми поздравлениями и радостью!** 🎂
```
---
Это `README.md` включает всю необходимую информацию о проекте BirthdayWishes, включая основные функции, требования, установку, конфигурацию и руководство по использованию.

0 comments on commit 400968c

Please sign in to comment.