Giter VIP home page Giter VIP logo

nik-tiger-bill / yamdb_final Goto Github PK

View Code? Open in Web Editor NEW
5.0 1.0 1.0 131 KB

REST API для отзывов на произведения. Здесь можно писать, как положительные, так и отрицательные отзывы. Может написать, какой фильм не очень и мы даже не удалим вашу запись

Home Page: http://62.84.119.129/admin/

Shell 0.41% Python 97.60% Dockerfile 0.41% HTML 1.58%
django djago-rest-framework python3 postgresql ngin gunicorn docker github-actions yandex-cloud

yamdb_final's Introduction

YaMDB

example workflow

Python Django Django REST Framework PostgreSQL Nginx gunicorn docker GitHub%20Actions Yandex.Cloud

Проект YaMDb собирает отзывы (Review) пользователей на произведения (Titles). Произведения делятся на категории: «Книги», «Фильмы», «Музыка». Список категорий (Category) может быть расширен администратором (например, можно добавить категорию «Изобразительное искусство» или «Ювелирка»). Сами произведения в YaMDb не хранятся, здесь нельзя посмотреть фильм или послушать музыку. В каждой категории есть произведения: книги, фильмы или музыка. Например, в категории «Книги» могут быть произведения «Винни-Пух и все-все-все» и «Марсианские хроники», а в категории «Музыка» — песня «Давеча» группы «Насекомые» и вторая сюита Баха. Произведению может быть присвоен жанр (Genre) из списка предустановленных (например, «Сказка», «Рок» или «Артхаус»). Новые жанры может создавать только администратор. Благодарные или возмущённые пользователи оставляют к произведениям текстовые отзывы (Review) и ставят произведению оценку в диапазоне от одного до десяти (целое число); из пользовательских оценок формируется усреднённая оценка произведения — рейтинг (целое число). На одно произведение пользователь может оставить только один отзыв.

Подготовка и запуск проекта

Склонировать репозиторий на локальную машину:

git clone https://github.com/NIK-TIGER-BILL/yamdb_final

Для работы с удаленным сервером (на ubuntu):

  • Выполните вход на свой удаленный сервер

  • Установите docker на сервер:

sudo apt install docker.io 
  • Установите docker-compose на сервер:
sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
  • Локально отредактируйте файл nginx.conf и в строке server_name впишите свой IP
  • Скопируйте файлы docker-compose.yml и nginx.conf из репозитория на сервер:
scp docker-compose.yml <username>@<host>:/home/<username>/docker-compose.yml
scp nginx.conf <username>@<host>:/home/<username>/nginx.conf
  • Cоздайте .env файл и впишите:

    DB_ENGINE=<django.db.backends.postgresql>
    DB_NAME=<имя базы данных postgres>
    DB_USER=<пользователь бд>
    DB_PASSWORD=<пароль>
    DB_HOST=<db>
    DB_PORT=<5432>
    SECRET_KEY=<секретный ключ проекта django>
    
  • Для работы с Workflow добавьте в Secrets GitHub переменные окружения для работы:

    DB_ENGINE=<django.db.backends.postgresql>
    DB_NAME=<имя базы данных postgres>
    DB_USER=<пользователь бд>
    DB_PASSWORD=<пароль>
    DB_HOST=<db>
    DB_PORT=<5432>
    
    DOCKER_PASSWORD=<пароль от DockerHub>
    DOCKER_USERNAME=<имя пользователя>
    
    SECRET_KEY=<секретный ключ проекта django>
    
    USER=<username для подключения к серверу>
    HOST=<IP сервера>
    PASSPHRASE=<пароль для сервера, если он установлен>
    SSH_KEY=<ваш SSH ключ (для получения команда: cat ~/.ssh/id_rsa)>
    
    TELEGRAM_TO=<ID чата, в который придет сообщение>
    TELEGRAM_TOKEN=<токен вашего бота>
    

    Workflow состоит из трёх шагов:

    • Проверка кода на соответствие PEP8
    • Сборка и публикация образа бекенда на DockerHub.
    • Автоматический деплой на удаленный сервер.
    • Отправка уведомления в телеграм-чат.
  • На сервере соберите docker-compose:

sudo docker-compose up -d --build
  • После успешной сборки на сервере выполните команды (только после первого деплоя):
    • Соберите статические файлы:
    sudo docker-compose exec backend python manage.py collectstatic --noinput
    
    • Примените миграции:
    sudo docker-compose exec backend python manage.py migrate --noinput
    
    • Команда для заполнения базы начальными данными (необязательно):
    docker-compose exec web python manage.py loaddata fixtures.json
    
    • Создать суперпользователя Django:
    sudo docker-compose exec backend python manage.py createsuperuser
    
    • Проект будет доступен по вашему IP

Проект в интернете

Проект запущен и доступен по адресу

Авторы.

lightmatter314. Управление пользователями: система регистрации и аутентификации, права доступа, работа с токеном, система подтверждения e-mail.

nicefme. Категории, жанры и произведения: модели, view и эндпойнты для них.

NIK-TIGER-BILL. Отзывы, комментарии и рейтинги произведений: модели и view, эндпойнты для них.

yamdb_final's People

Contributors

nik-tiger-bill avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

Forkers

morefine17

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.