https://github.com/Winterfulllll/RECO

Recommendation web service 🔎
https://github.com/Winterfulllll/RECO

flask html-css-js python recommendation-web-service

Last synced: 11 months ago
JSON representation

Recommendation web service 🔎

• Host: GitHub
• URL: https://github.com/Winterfulllll/RECO
• Owner: Winterfulllll
• Created: 2024-03-06T12:25:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-26T17:18:35.000Z (about 2 years ago)
• Last Synced: 2025-01-30T06:29:02.936Z (over 1 year ago)
• Topics: flask, html-css-js, python, recommendation-web-service
• Language: HTML
• Homepage:
• Size: 9.36 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# RECO - Recommendation Web Service 🔎

WEB-сервис, который использует передовые технологии искусственного интеллекта для анализа и генерации рекомендаций фильмов на основе предпочтений пользователя! 🎯

![Баннер](data/images/banner.png)

## Состав команды разработчиков 👨🏻‍💻

- **Горячкин Владимир Олегович** - Тимлид, архитектор, дизайнер

- **Павлюшин Максим Кириллович** - Backend-разработчик

- **Прокофьев Илья Алексеевич** - Backend-разработчик

- **Ситников Илья Александрович** - Frontend-разработчик

## Стек используемых технологий ✨

### Backend 🔧

- [**Python**](https://www.python.org) - Основной язык программирования для backend-части проекта;

- [**Flask**](https://flask.palletsprojects.com/en/3.0.x/) - Микрофреймворк Python для создания веб-приложений и API;

- [**Connexion**](https://connexion.readthedocs.io/en/latest/) - Расширение Flask для создания OpenAPI-совместимых API;

- [**SQLAlchemy**](https://www.sqlalchemy.org) - ORM (Object-Relational Mapper) для работы с базами данных;

- [**Marshmallow**](https://marshmallow.readthedocs.io/en/stable/) - Библиотека для сериализации/десериализации данных;

- [**Flask-JWT-Extended**](https://flask-jwt-extended.readthedocs.io/en/stable/api.html) - Расширение Flask для работы с JWT (JSON Web Tokens) для аутентификации.

### Frontend 🎨

- [**JavaScript**](https://js-documentation.netlify.app) - Основной язык программирования для frontend-части проекта;

- [**HTML/CSS**](https://html.spec.whatwg.org) - Для создания структуры и стиля веб-страниц.

### Другие инструменты 🧩

- [**Swagger**](https://docs.swagger.io) - Для документирования и удобного тестирования собственного API;

- База данных [**SQLite**](https://www.sqlite.org) - Лёгкая БД, подходящая для небольших проектов.

## Процесс установки и запуска ⚙️

Для начала, **установите** [***Python***](https://ekohl.github.io/tutorial/en/python_installation/) и [***GIT***](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git) на свой компьютер 🐍

После этого, [**скопируйте**](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) репозиторий *(Сделать это можно в терминале ОС с помощью `git clone https://github.com/Winterfulllll/SIGMANIZATION.git`)*

**Перейдите** в скопированную директорию - `cd SIGMANIZATION`

Затем, **создайте** и **войдите** в [*виртуальное окружение*](https://github.com/AndrewVolkova/Python/blob/master/Visual/venv/instruction.ipynb) *(опционально)*

*Как пример*, это можно сделать **так**:

```shell

python -m venv venv

venv\Scripts\activate.ps1

```

**Установите** необходимые для работоспособности сервиса *python-библиотеки*

```shell

pip install -r requirements.txt

```

**Настройте** файл с название `.env` по инструкции

[*Подробная инструкция по настройке `.env` файла*](./data/env_instruction.md)

В конце концов, запустите код с помощью команды `uvicorn main:app --reload`

## Полезные ссылки 🔗

- [Предпросмотр 👀](data/preview.md)

- [Архитектура проекта ⚡](https://miro.com/welcomeonboard/QWFYamxJb1ZoaUh2Mzl4dkZVbmI3SmdZRDk2eW02cnJWRzZkcGlMamxjVDA1UTlzVzZBMThtdWd5bXIwZEtodXwzNDU4NzY0NTgxMTYzMzk3MDc2fDI=?share_link_id=838149588957)