GithubHelp home page GithubHelp logo

diary-workout-tracker / diary-workout-tracker-backend Goto Github PK

View Code? Open in Web Editor NEW
3.0 0.0 0.0 2.78 MB

Backend приложения "100 дней бега"

Dockerfile 0.32% Python 79.83% Makefile 1.05% HTML 18.05% CSS 0.13% JavaScript 0.62%
celery django django-rest-framework docker javascript makefile nginx posgresql pre-commit pytest redis ruff poetry

diary-workout-tracker-backend's Introduction

diary-workout-tracker-backend

Workflow Workflow

Описание

Backend приложения "100 дней бега".

Возможности: функционал работы с пользователем(регистрация, авторизация, аутентификация), получение тренировок, ачивок, истории, сохранение истории.

Технологии

Nginx PostgreSQL Swagger Docker

Python Django Django Rest Framework

Ruff Pytest

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

Настройка и запуск локально для разработки

Проект использует Poetry как инструмент управления зависимостями.

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

    git clone [email protected]:Diary-workout-tracker/diary-workout-tracker-backend.git
    cd diary-workout-tracker-backend
  2. Создание и активация виртуального окружения при помощи poetry

    2.1 Создание отдельного окружения

    python -m venv venv
    source venv/Scripts/activate

    для Linux и macOS

    python3 -m venv venv
    source venv/bin/activate

    2.2 Использование poetry

    pip install poetry
    poetry shell
    poetry install

Примечание: версия python должна быть ^3.11.

  1. Инициализация pre-commit.
    poetry run pre-commit install
  2. Создайте и заполните файл .env согласно шаблону .env.example
  3. Выполнить команду Make в консоли.
    make project-init-dev # при первом запуске
    make project-start-dev # при последующих запусках

Дополниельные сведения для разработчика

Полезные материалы

Команды poetry

  • Создание нового проекта: poetry new new_project
  • Установка зависимостей: poetry install
  • Запуск виртуального окружения: poetry shell
  • Внедрение Poetry в уже имеющийся проект: poetry init
  • Обновление зависимостей: poetry update
  • Добавление новой библиотеки: poetry add <имя_библиотеки>
  • Удаление зависимости: poetry remove <имя_библиотеки>
  • Просмотр зависимостей: poetry show
  • Запуск из виртуального окружения: poetry run <команда>

Команды pre-commit

Важно С использованием poetry, выполнение команд из виртуального окружения происходит через poetry run <команда>.

  • Установить pre-commit в проекте: pre-commit install
  • Запустить проверку всех хуков: pre-commit run -a
  • Запустить конкретный хук: poetry run pre-commit run <имя-хука>
  • Деактивировать автоматическое выполнение хуков перед коммитом: poetry run pre-commit uninstall
  • Обновить pre-commit хуки: poetry run pre-commit autoupdate

Команды make

  • Удаление Volumes: make clear-volumes-dev
  • Запуск контейнеров: make start-containers-dev
  • Выполнить миграции Django: make migrate-dev
  • Собрать статику Django: make collectstatic-dev
  • Создать супер пользователя: make createsuperuser-dev
  • Загрузка фикстур достижений make loadachievment-dev
  • Запуск сервера: make start-server-dev
  • Инициализировать проект: make project-init-dev
  • Запустить проект: make project-start-dev
  • Остановить контейнеры: make containers-stop-dev

Разработчики

Струнникова Елизавета

Оганин Петр

Шапиро Алексей

Яременко Владислав

Ястребов Владислав

diary-workout-tracker-backend's People

Contributors

blakkheart avatar holohup avatar luna-luns avatar necroshizo avatar vladislavyar avatar

Stargazers

 avatar  avatar  avatar

diary-workout-tracker-backend's Issues

Ограничение количества запросов кода

Зачем?

Чтобы соответствовать фичлисту

Где?

Модуль авторизации

Что должно получиться?

если код запрашивается 5 раз подряд, до вктючается таймер 5 мин до возможности отправки нового кода. ДРФ начинает отдавать ошибку, в подробностях которой описано сколько секунд осталось ждать, чтобы приложение знало, что говорить пользователю

Ограничение включается в случае, если код запрашивался 5 раз подряд в течение 10 минут.

Также должны быть написаны тесты, проверяющие краевые случаи, основной функционал и случаи, когда ограничение не должно срабатывать

Расписать эндпоинты

Зачем?

Зачем выполняется реализация задачи и какую проблему она решает

Где?

Где делаем реализацию задачи, какие требования, что задействуваем

Что должно получится?

Какой эффект должен получится

троттлинг для дрф

Зачем?

Чтобы избежать нагрузки, связанной с большим количеством запросов, которое может возникнуть как результат действий злоумышленника(ов), так и из-за особенностей настройки и работы приложения

Где?

На сервере, в Джанго ДРФ

Что должно получиться?

После некоторого количества запросов в единицу времени с одного устройства должен включаться период охлаждения, когда вместе ответа с данными сервер отдает заглушку.

Дополнить модель пользователя согласно последним изменениям в фич-лист

Зачем?

Чтобы взаимодействие с iOS приводило к желаемому результату

Где?

_Сделать поле ИМЯ обязательным при регистрации, выводить его при внесении изменений _
Добавить необязательные поля рост и вес.

Что должно получится?

ИМЯ должно корректно обрабатываться сериализатором, без имени регистрация не должна быть возможной Также должны добавиться поля рост и вес.

Аутентификации

Зачем?

Для идентификации пользователя

Где?

.

Что должно получится?

  1. При вводе email регистрация пользователя и выделение токена, если email есть пересоздание токена и генерация токена
  2. Отправка сгенерированного кода через почтовый сервис
  3. При получение кода подтверждения возврат токена

Почтовый сервис

Зачем?

Для отправки кода подтверждения

Где?

.

Что должно получится?

На почту должен приходить шаблон с кодом подтверждения

ER-диаграмма

Зачем?

Для формирования данных для работы проекта согласно требования QA и написания моделей

Где?

Отдельное приложение django

Что должно получится?

ER-диаграмма

Создать docker-compose-dev

Зачем?

Зачем выполняется реализация задачи и какую проблему она решает

Где?

Где делаем реализацию задачи, какие требования, что задействуваем

Что должно получится?

Какой эффект должен получится

Модели django

Зачем?

Написания моделей по ER-диаграмме

Где?

Отдельное приложение django

Что должно получится?

Составленные модели, рабочая миграция,

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.