Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pacmancity/opiniorater
rest-api для сбора отзывов📝 пользователей о произведениях(Книги📚, фильмы🎬 и музыка🔊)
https://github.com/pacmancity/opiniorater
django django-rest-framework jwt-authentification python rest-api sqlite
Last synced: 10 days ago
JSON representation
rest-api для сбора отзывов📝 пользователей о произведениях(Книги📚, фильмы🎬 и музыка🔊)
- Host: GitHub
- URL: https://github.com/pacmancity/opiniorater
- Owner: pacmancity
- License: mit
- Created: 2023-03-27T19:56:51.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-11-08T17:02:03.000Z (about 1 year ago)
- Last Synced: 2024-09-11T18:26:55.023Z (2 months ago)
- Topics: django, django-rest-framework, jwt-authentification, python, rest-api, sqlite
- Language: Python
- Homepage:
- Size: 117 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpinioRater
[](https://python.org)
[](https://www.djangoproject.com/)
[](https://www.django-rest-framework.org/)
[](https://github.com/kluev-evga/api_final_yatube/blob/master/LICENSE)
## О ПРОЕКТЕ
Проект - это RESTful API, разработанный для сбора отзывов пользователей о различных произведениях, таких как книги,
фильмы и музыка. Этот API предоставляет удобный и эффективный способ для пользователей выражать свое мнение и оценивать
произведения в различных категориях развлечений.
Основные функции API включают:
1. Регистрация и аутентификация пользователей: Пользователи могут создавать учетные записи и аутентифицироваться для
доступа к сервису.
2. Добавление отзывов: Пользователи могут оставлять отзывы и комментарии к книгам, фильмам и музыке, выражая свои мнения
и рецензии.
3. Рейтинг и оценка: Пользователи могут проставлять оценки и рейтинги произведениям, что позволяет другим пользователям
легче находить популярные и рекомендуемые работы.
4. Поиск и фильтрация: API предоставляет возможность поиска произведений по различным критериям, таким как жанр, автор,
режиссер и многое другое.
5. Интеграция с произведениями: С помощью API можно получать информацию о книгах, фильмах и музыке из внешних
источников, обогащая базу данных произведений.
6. Аналитика и отчеты: Администраторы могут получать отчеты о активности пользователей и популярности произведений.
Этот проект предоставляет платформу для обмена мнениями и рекомендациями, помогая пользователям находить интересные
произведения и делиться своими впечатлениями.
Stack проекта: Django, Django-rest-framework, simpleJWT, sqlite
### Команда разработки:
## ЗАПУСК ПРОЕКТА
WINDOWS ▶️
_Клонировать проект_
```shell
git clone https://github.com/kluev-evga/api_yamdb.git
```
_Установить локальное окружение_
```shell
python -m venv venv
```
_Активировать окружение_
```shell
venv\Scripts\activate # PowerShell
```
```shell
source venv/Scripts/activate # Git Bash(Bash)
```
_Установить зависимости_
```shell
pip install -r requirements.txt
```
_Перейти в папку с проектом_
```shell
cd .\api_yamdb\
```
_Выполнить миграции_
```shell
python3 manage.py migrate
```
_запустить сервер_
```shell
python3 manage.py runserver
```
LINUX & MacOS▶️
_Клонировать проект_
```shell
git clone https://github.com/kluev-evga/api_yamdb.git
```
_Установить локальное окружение_
```shell
python3 -m venv venv
```
_Активировать окружение_
```shell
source venv/bin/activate
```
_Установить зависимости_
```shell
pip install -r requirements.txt
```
_Перейти в папку с проектом_
```shell
cd .\api_yamdb\
```
_Выполнить миграции_
```shell
python3 manage.py migrate
```
_запустить сервер_
```shell
python3 manage.py runserver
```
## БАЗА ДАННЫХ
База данных построена на основе SQLITE.
[Схема](https://dbdocs.io/kluev.evga/api_aymdb?view=relationships) базы данных создана при
помощи [DBML](https://www.dbml.org/docs/#project-definition) синтаксиса и приложения [dbdocs](https://dbdocs.io/).
Файл схеммы [graph-db.dbml](https://github.com/kluev-evga/api_yamdb/blob/master/graph-db.dbml).
[Установка](https://dbdocs.io/docs) и запуск приложения dbdocs:
```shell
npm install -g dbdocs
```
```shell
dbdocs login
```
выбрать метод аутентификации Email, указать свой email, скопировать код из email и вставить в консоль
```shell
dbdocs build graph-db.dbml
```
Последний шаг выведет в консоль ссылку на задеплоенный проект.
## Добавление данных из csv файлов
Команда для добавления данных из csv
_перейти в папку с проектом_
```shell
cd api_yamdb
````
_добавить все файлы из папки api_yamdb/static/data_
```shell
python3 manage.py import_data_csv
```
_добавить отдельный файл:_
```shell
python3 manage.py import_data_csv —[file name].csv
```
## Регистрация и авторизация
```mermaid
graph LR
api/v1/auth/signup-->POST;
POST-->user-exists?;
user-exists?-->yes-->skip-->Email_confirmation_code;
user-exists?-->no-->create-user-->Email_confirmation_code;
```
```json
{
"email": "[email protected]",
"username": "john_doe"
}
```🔊
JWT
```mermaid
graph LR
api/v1/auth/token-->POST-->JWT-token;
```
```json
{
"username": "john_doe",
"confirmation_code": "blyxv3-48b382b52eb0d5885cd281ca10a85839"
}
```
## ЛИЦЕНЗИЯ
Распространяется по `MIT` лицензии. Для дополнительной информации
смотри: [LICENSE](https://github.com/kluev-evga/api_yamdb/blob/master/LICENSE)