Фронтенд проекта ESKA-CINEMA

Requirements

• python 3.11
• IDE (pycharm, vscode, etc...)
• git

Подготовка

1. Установить Python 3.11
2. Клонировать основной репозиторий

   $ git clone https://github.com/Eskander739/eska-cinema-frontend.git
   

3. Установить системный Python в качестве основного:

   File -> Settings -> Project(Project name) -> Python Interpreter -> Add Interpreter
   Add Local Interpreter -> System Interpreter -> Указываем путь до исполняемого файла Python, в Windows обычно это:
   C:\Users\username\AppData\Local\Programs\Python
   

4. Установить requirements

   $ pip install -r requirements.txt
   

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

├── eska-cinema-frontend # Директория с проектом
│   └── app # Директория для работы с css, js, html
│       ├── static # Статичные файлы проекта
│       │    ├── css 
│       │    │    └── style.css # Стили проекта
│       │    ├── img
│       │    │    └── eska-cinema.png # Основной логотип проекта
│       │    └── js 
│       │         ├── auth.js # Объекты для работы с авторизацией, де-авторизацией, регистрацией
│       │         ├── client_api.js # Общий API клиент для взаимодействия с сервером
│       │         ├── config.js # Конфигурационный файл проекта
│       │         ├── home.js # Объекты для работы с главным разделом проекта
│       │         ├── player.js # Объекты для работы с веб плеером проекта
│       │         ├── profile.js # Объекты для работы с профилем пользователя
│       │         └── subscription.js # Объекты для работы с подпиской
│       │
│       └── templates
│           ├── home.html # Главная страница
│           ├── index.html # Страница для регистрации/авторизации
│           ├── player.html # Страница веб плеера
│           ├── profile.html # Страница профиля
│           └── subscription.html # Страница подписок
├── src # Директория с инструментами
│   │
│   ├── models # Директория моделей
│   │   └──  error.py # Pydantic и Enum модели ошибок
│   │
│   ├── security # Директория объектов для работы с сессиями и безопасностью
│   │   └── jwt.py # Объекты для работы с JWT токенами 
│   └── redis_service.py # Объекты для управления сессиями Redis
├── .env # Файл с переменными
├── .gitignore # Файл для игнорирования мусора при работа с Git
├── cert.pem # Сертификат проекта
├── key.pem # Ключ от сертификата проекта
├── main.py # Файл с методами FastAPI
├── README.md # Файл для описания структуры проекта
└── requirements.txt # Файл с необходимыми библиотеками для работы проекта

Перед созданием MR'а обязательно прогонять весь проект через black

Подготовка

1. Открываем командную строку
2. Переходим в папку с проектом
3. Прописываем команду:

   python/python3 -m black ./
   

4. Нажимаем Enter
5. После проведения доработок со стороны библиотеки black можно пушить изменения и создавать merge request