Commit 5f3928e

CourseWork_8

Курсовая работа

Проект 5. Трекер привычек
Ветка develop

Содержание

Требования
Начало работы
- Установка зависимостей
- Тестирование
FAQ
To do
Команда проекта
Источники

Требования

Техническое задание на разработку веб-приложения с рассылкой сообщений

Контекст В 2018 году Джеймс Клир написал книгу «Атомные привычки», которая посвящена приобретению новых полезных привычек и искоренению старых плохих привычек. Заказчик прочитал книгу, впечатлился и обратился к вам с запросом реализовать трекер полезных привычек. В рамках учебного курсового проекта реализуйте бэкенд-часть SPA веб-приложения.

Технологии

Python
Django
PostgreSQL
Redis
Celery

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

Разработка

Описание задач

Добавьте необходимые модели привычек. Реализуйте эндпоинты для работы с фронтендом. Создайте приложение для работы с Telegram и рассылками напоминаний.

Модели

В книге хороший пример привычки описывается как конкретное действие, которое можно уложить в одно предложение:

я буду [ДЕЙСТВИЕ] в [ВРЕМЯ] в [МЕСТО]

За каждую полезную привычку необходимо себя вознаграждать или сразу после делать приятную привычку. Но при этом привычка не должна расходовать на выполнение больше двух минут. Исходя из этого получаем первую модель — «Привычка».

Привычка:

Пользователь — создатель привычки.
Место — место, в котором необходимо выполнять привычку.
Время — время, когда необходимо выполнять привычку.
Действие — действие, которое представляет собой привычка.
Признак приятной привычки — привычка, которую можно привязать к выполнению полезной привычки.
Связанная привычка — привычка, которая связана с другой привычкой, важно указывать для полезных привычек, но не для приятных.
Периодичность (по умолчанию ежедневная) — периодичность выполнения привычки для напоминания в днях.
Вознаграждение — чем пользователь должен себя вознаградить после выполнения.
Время на выполнение — время, которое предположительно потратит пользователь на выполнение привычки.
Признак публичности — привычки можно публиковать в общий доступ, чтобы другие пользователи могли брать в пример чужие привычки.

Валидаторы

Исключить одновременный выбор связанной привычки и указания вознаграждения.
Время выполнения должно быть не больше 120 секунд.
В связанные привычки могут попадать только привычки с признаком приятной привычки.
У приятной привычки не может быть вознаграждения или связанной привычки.
Нельзя выполнять привычку реже, чем 1 раз в 7 дней.

Пагинация

Для вывода списка привычек реализовать пагинацию с выводом по 5 привычек на страницу.

Права доступа

Каждый пользователь имеет доступ только к своим привычкам по механизму CRUD.
Пользователь может видеть список публичных привычек без возможности их как-то редактировать или удалять.

Эндпоинты

Регистрация.
Авторизация.
Список привычек текущего пользователя с пагинацией.
Список публичных привычек.
Создание привычки.
Редактирование привычки.
Удаление привычки.

Интеграция

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

Для этого потребуется интегрировать сервис с мессенджером Телеграм, который будет заниматься рассылкой уведомлений.

Безопасность

Для проекта необходимо настроить CORS, чтобы фронтенд мог подключаться к проекту на развернутом сервере.

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

Для реализации экранов силами фронтенд-разработчиков необходимо настроить вывод документации. При необходимости эндпоинты, на которые документация не будет сгенерирована автоматически, описать вручную.

Начало работы

Установка зависимостей

Клонируйте репозиторий

git clone git@github.com:AlexKozhanov/CourseWork_8.git

Установите зависимости

poetry install

Создайте файл .env из копии файла .env.sample и вставьте значения переменных своими данными

copy .env.sample .env

Не забудьте создать БД
Активируйте миграции

python manage.py migrate

Внесите свои настройки, в файл .env.example, переименуйте в .env

copy .env.sample .env

Зарегистрируйте суперпользователя

python manage.py csu

Активируйте Redis

redis-server

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

python manage.py runserver

Запустите во второй вкладке celery beat:

celery -A config beat -l info -S django

Запустите в терминале celery worker:

celery -A config worker -l INFO

Зайдите в телеграм бот, и нажмите

/start

Docker

Серверные настройки

Подключитесь к своему серверу

ssh user_name@your_server_ip

Запустите необходимые обновления

sudo apt update && sudo apt upgrade

Настройте брандмауэр и откройте необходимые порты

sudo ufw status
sudo ufw enable #in case firewal is turned off
sudo ufw allow 80/tcp
sudo ufw allow 443/tcp
sudo ufw allow 22/tcp

Инициализация

git clone git@github.com:AlexKozhanov/CourseWork_8.git

Установите зависимости

poetry install

Создайте файл .env из копии файла .env.sample и вставьте значения переменных своими данными

copy .env.sample .env

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

docker-compose up --build

Проект успешно запущен! Проект будет доступен по адресу:

http://localhost:8000

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Commit 5f3928e

1 file changed

1 file changed

`‎README.md‎`

CourseWork_8

Содержание

Требования

Техническое задание на разработку веб-приложения с рассылкой сообщений

Технологии

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

Разработка

Начало работы

Установка зависимостей

Docker

Серверные настройки

Инициализация

Тестирование

FAQ

Зачем вы разработали этот проект?

To do

Команда проекта

Источники

File tree

1 file changed

1 file changed

‎README.md‎

CourseWork_8

Содержание

Требования

Техническое задание на разработку веб-приложения с рассылкой сообщений

Технологии

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

Разработка

Начало работы

Установка зависимостей

Docker

Серверные настройки

Инициализация

Тестирование

FAQ

Зачем вы разработали этот проект?

To do

Команда проекта

Источники

0 commit comments

`‎README.md‎`