Code Monkey home page Code Monkey logo

api_yamdb_final's Introduction

example workflow

API YaMDB

API YaMDB - командный проект, поддерживающий обмен данными в формате JSON. Развернут в 3х контейнерах (db, web, nginx) c помощью Docker.

Настроены CI и CD: автоматический запуск тестов (PEP8, Pytest), обновление образов на Docker Hub,автоматический деплой на боевой сервер при пуше в ветку master.

Cистема аутентификация реализована через получение JWT-токена. Функционал API предоставляет следующие ресурсы:

  • Произведения
  • Категории
  • Жанры
  • Отзывы
  • Комментарии

Технологии:

  • Python 3
  • Django Rest Framework
  • Simple JWT
  • PostgreSQL
  • Docker

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

1. Склонировать репозиторий

git clone https://github.com/AndreyVnk/yamdb_final.git && cd yamdb_final/

2. Добавить Action Secrets

DOCKER_USERNAME=<docker login>
DOCKER_PASSWORD=<docker password>
USER=<server_user>
HOST=<server_ip_address>
SSH_KEY=<public_key> # cat ~/.ssh/id_rsa (linux) на машине имеющей доступ к серверу
TELEGRAM_TO=<chat ID> # для отправки уведомлений в телеграм через бота
TELEGRAM_TOKEN=<bot_token> # для отправки уведомлений в телеграм через бота
SECRET_KEY=secret_django_key
DB_ENGINE=django.db.backends.postgresql # указываем, что работаем с postgresql
DB_NAME=postgres # имя базы данных
POSTGRES_USER=postgres # логин для подключения к базе данных
POSTGRES_PASSWORD=zzzxxxcc # пароль для подключения к БД (установите свой)
DB_HOST=db # название сервиса (контейнера)
DB_PORT=5432 # порт для подключения к БД

3. Изменить настройки default.conf в папке infra/nginx/

server_name <server_ip_address>;

4. Подготовьте сервер

Установите docker и docker-compose

https://docs.docker.com/engine/

5. Выполнить копирование файлов docker-compose.yaml и nginx/default.conf на сервер

scp infra/docker-compose.yaml <user>@<ip_address>:/home/<user>/docker-compose.yaml
scp infra/nginx/default.conf <user>@<ip_address>:/home/<user>/nginx/default.conf

6. Выполнить commit и push проекта

git add .
git commit -m 'something'
git push

7. На сервере выполнить следующие команды

sudo docker-compose exec web python manage.py migrate
sudo docker-compose exec web python manage.py collectstatic --no-input
sudo docker-compose exec web python manage.py createsuperuser
sudo docker-compose exec web python manage.py changepassword <username superuser>

Эндпоинты, описанные в документации доступны на корневом адресе проекта: http://<server_ip_address>/api/v1/. Документация к API доступна на http://<server_ip_address>/redoc/.

Пример проекта доступен по http://51.250.16.238/api/v1/ . Документация к API - http://51.250.16.238/redoc/ .

Авторы

AndreyVnk, deorz, idudnikov

api_yamdb_final's People

Contributors

andreyvnk avatar

Stargazers

Mark Mazurov avatar Kirill avatar

Watchers

 avatar

Forkers

lobanev

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.