Choose Your Consequence | Проект Яндекс Лицей

Ссылка на сайт

Содержание

0. Инструкция по установке и запуску
1. Введение
   1. Идея проекта
   2. Процесс пользования
2. Описание реализации
   1. Структура приложения сайта
   2. Особенности реализации
   3. Используемые технологии
3. Заключение
   1. Планы на будущее

0. Инструкция по развёртыванию

1. Скачать и установить Python v3.9.x или выше
2. Клонировать репозиторий git clone https://github.com/Data-Name-ID/choose-your-consequence.git далее перейти в папку проекта cd choose-your-consequence
3. Установить зависимости с помощью pip pip install -r requirements.txt
4. Запустить сервер python server.py

1.1 Идея проекта

Пояснительная записка

Презентация

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

1.2 Процесс пользования

Пользователь, заходя на главную страницу сайта, увидит вопрос и два варианта-исхода. Он может сделать свой выбор, после этого перейдет на страницу вопроса и увидит соотношение ответов пользователей: сколько человек выбрало первый вариант, сколько – второй. Пользователь может оставлять комментарии, если войдет в учетную запись, а также лайкать чужие. Кроме того, пользователь может зайти в личный кабинет и увидеть свои ответы на вопросы. Администратор может добавлять вопросы, изменять существующие и удалять их.

2.1 Структура приложения сайта

1. server.py - главный файл приложения
2. requirements.txt - файл с перечнем зависимостей
3. data - папка с используемыми в приложении моделями и API методами
4. static - папка, содержащая статичные ресурсы приложения, такие как библиотеки BootStrap и jQuery, изображения, аватары пользователей и т.п.
5. db - папка, в которой находятся база данных
6. forms - содержит все формы приложения
7. templates - папка со всеми HTML шаблонами
8. сonfig.py – файл конфигурации
9. start.sh – файл, необходимый для запуска приложения на glitch.com
10. LICENSE – файл публичной лицензии проекта

2.2 Особенности реализации и функции

1. Возможность регистрации и входа
2. Возможность регистрации в качестве администратора с помощью специального токена
3. Шифрование пароля пользователя
4. Простое добавление новых вопросов, возможность их редактирования и удаления
5. Реализован API для взаимодействия с базой данных
6. Использование форм и моделей
7. Реализована загрузка аватаров пользователей при регистрации
8. Возможность оставлять комментарии и лайкать чужие

2.3 Используемые технологии

• Python
• Flask
• Flask-WTF
• SQLAlchemy
• Flask-Login
• Pillow
• HTML
• CSS
• Bootstrap
• JavaScript
• jQuery

3.1 Планы на будущее

• Добавление возможности редактирования комментариев
• Добавление тёмной темы сайта
• Добавление функции предложения постов от пользователей
• Добавить просмотр автора вопроса и просмотр профилей
• Добавить возможность отвечать на комментарии, создавая ветки ответов
• Другие улучшения