GithubHelp home page GithubHelp logo

foodgram-project-react's Introduction

IP  158.160.12.247
https://foodgram-stigos.ddns.net
superuser "stigos"  password: stigos1976
email: [email protected] password: stigos1976 

Foodgram

Проект позволяет:

  • публиковать рецепты
  • подписываться на рецепты авторов
  • добавлять понравившиеся рецепты в избранное
  • сохранять рецепты в список покупок

Добавлять, редактировать и удалять рецепты могут только зарегистрированные пользователи.
Зарегистрированным пользователям доступны все возможности проекта.
Для работы с проектом понадобятся следующие технологии

Как запустить проект:

Клонировать репозиторий и перейти в него в командной строке:

[email protected]:SarkisyanTV/foodgram-project-react.git
cd foodgram-project-react

Создать и активировать виртуальное окружение:

python3 -m venv env
  • Если у вас Linux/macOS

    source env/bin/activate
    
  • Если у вас windows

    source env/scripts/activate
    
python3 -m pip install --upgrade pip

Установить зависимости из файла requirements.txt:

pip install -r requirements.txt

Перейти в папку backend/:

cd backend

Выполнить миграции:

python3 manage.py migrate

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

python3 manage.py runserver

В проекте использована технология Docker, о том как установить Doker на свою машину
вы можете прочитать здесь https://docs.docker.com/engine/install/ubuntu/

Запустить проект c Docker:

$ cd infra/
$ sudo docker compose up

Проект будет доступен в браузере по адресу http://localhost/

Использование API проекта

В проекте использована библиотека Djoser https://djoser.readthedocs.io/en/latest/settings.html
для работы с пользователями. Авторизация пользователей реализована по токенам.

Api доступен по адресу http://localhost/api/

Документация к api http://localhost/api/docs/

Пример:

Перейдя по адресу
GET http://localhost/api/users/ вы получите список всех зарегистрированных пользователей.

POST http://localhost/api/users/ c данными в формате Json
вы зарегистрируете нового пользователя. :

{

   "email": "[email protected]",
   "username": "vasya.pupkin",
   "first_name": "Вася",
   "last_name": "Пупкин",
   "password": "Qwerty123"

}

GET http://localhost/api/recipes/ список всех постов:

{

    "count": 123,
    "next": "http://foodgram.example.org/api/recipes/?page=4",
    "previous": "http://foodgram.example.org/api/recipes/?page=2",
    "results": 

[

{

    "id": 0,
    "tags": 

[

    {
        "id": 0,
        "name": "Завтрак",
        "color": "#E26C2D",
        "slug": "breakfast"
    }

],
"author": 
{

    "email": "[email protected]",
    "id": 0,
    "username": "string",
    "first_name": "Вася",
    "last_name": "Пупкин",
    "is_subscribed": false

},
"ingredients": 
[

                {
                    "id": 0,
                    "name": "Картофель отварной",
                    "measurement_unit": "г",
                    "amount": 1
                }
            ],
            "is_favorited": true,
            "is_in_shopping_cart": true,
            "name": "string",
            "image": "http://foodgram.example.org/media/recipes/images/image.jpeg",
            "text": "string",
            "cooking_time": 1
        }
    ]

}

Автор

Тигран Саркисян, студент Яндекс.Пактикум python-backend E-mail: [email protected]

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.