Coder Social home page Coder Social logo

ilyavasilevsky47 / api_yamdb Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 0.0 179 KB

API YaMDb - это программный интерфейс, предназначенный для социальной сети, которая позволяет пользователям оставлять отзывы на различные произведения.

Python 99.50% HTML 0.38% Dockerfile 0.12%
django django-rest-framework python

api_yamdb's Introduction

API YaMDb

CI

API YaMDb - это программный интерфейс, предназначенный для социальной сети, которая позволяет пользователям оставлять отзывы на различные произведения.

Возможности:

  • Произведения классифицируются по категориям, таким как «Книги», «Фильмы», «Музыка», и могут быть отнесены к жанрам из списка доступных. Добавлять произведения, категории и жанры имеет право только администратор.
  • На сайте пользователи могут оставлять текстовые отзывы и оценивать произведения в диапазоне от 1 до 10. На основе пользовательских оценок вычисляется средняя оценка произведения. Пользователь может оставить только один отзыв на одно произведение. Добавлять отзывы, комментарии и оценивать произведения могут только аутентифицированные пользователи.

Запуск проекта:

  1. Клонируем проект.
git clone [email protected]:IlyaVasilevsky47/api_yamdb.git
  1. Создаем и активируем виртуальное окружение.
python -m venv venv
source venv/scripts/activate
  1. Обновляем менеджер пакетов pip и устанавливаем зависимости из файла requirements.txt.
python -m pip install --upgrade pip
pip install -r api_yamdb/requirements.txt
  1. Переходим в папку и создаем базу данных.
cd api_yamdb
python manage.py migrate 
  1. Загружаем тестовые данные в базу данных.
python manage.py database_import
  1. Запускаем проект.
python manage.py runserver 

Запуск через контейнеры:

  1. Переходим в папку и создаем файл.
cd infra
touch .env
  1. Заходим в файл.
nano .env
  1. Заполняем файл.
DB_ENGINE=django.db.backends.postgresql
DB_NAME=postgres
POSTGRES_USER=postgres
POSTGRES_PASSWORD=postgres
DB_HOST=db
DB_PORT=5432
  1. Запускаем контейнеры.
docker-compose up -d
  1. Создаем базу данных.
docker-compose exec web python manage.py migrate
  1. Заполняем тестовыми данными базу данных.
docker-compose exec web python manage.py database_import
  1. Собираем всю статику.
docker-compose exec web python manage.py collectstatic --no-input

Документация:

После запуска сервера локально, заходим в ReDoc по ссылке:

http://127.0.0.1:8000/redoc/

Если вы запустили сервер в контейнерах, то вам нужно перейти по этой ссылке:

http://localhost/redoc/

Авторы:

Имя GitHub
Илья Василевсикй ✔️
Игорь Белошицкий ✔️
Ангелина Тингаева ✔️

Технический стек

  • Python 3.7.9
  • Django 3.2.16
  • Django REST Framework 3.12.4
    • Simple JWT 4.8.0
  • PyJWT 2.1.0

api_yamdb's People

Contributors

ilyavasilevsky47 avatar igorbelosh avatar angelina91 avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.