ИДЗ - состав, порядок работы

Порядок выполнения

Для того, чтобы минимизировать риски неудачного создания пояснительной записки/приложения в последний момент, предлагается следующая последовательность шагов:

Как работать в репозиториях

Все требования по работе в репо перечислены в описаниях заданий ниже. Создавать специально для меня PR НЕ НУЖНО. Ждать моей проверки на ваших PR - бессмысленно:(

Я проверяю только содержимое ветки main - прошу к моменту сдачи заданий мержить наработки в main.

Как сдавать задания

На всякий случай, как оказалось, не все этот момент увидели в списке ниже - все задания по курсу сдаются путем написания письма преподавателю. Как и что писать - указано ниже.

Команда внимательно читает требования ниже, убеждается, что их результат соответствует описанию.

Команда внимательно смотрит в README своего репозитория и убеждается, что там напротив сдаваемого задания (все кроме 0) стоит метка Passing зеленого цвета.

Один участник команды (кого команда уполномочила сдавать это задание) пишет письмо преподвателю с темой “[NoSQL] Название_задания - номер_И_название_проекта”.

Остальные участники указываются в копии письма.

Переписка по одному заданию остается в рамках одной цепочки писем.

Если вам необходимо указать на объект в репозитории, предоставьте полную ссылку на него (такую, которая откроется по нажатию в браузере).

Если вы отправляете скринкаст - присылайте ссылку на него (прикладывать к письму не нужно).

Желательно, чтобы все участники команды сдали примерно одинаковое количество заданий ИДЗ ( == этапов, описанных ниже).

Что такое массовый импорт-экспорт

В каждой из ИДЗ необходимо реализовать функциональность массового импорта-экспорта. Что она подразумевает:

возможность импорта экспорта всех данных из системы в машино-читаемом формате (json, xml, csv .... на ваш выбор)

пользовательские интерфейсы для импорта и экспорта

Зачем это нужно:

потренироваться в создании простого модуля бакапа

посмотреть, какие возможности предоставляет ваша СУБД для работы с дампами БД

Согласована и сформулирована тема курсовой

Выбрать тему и согласовать ее с преподавателем. Вам нужно письмом:

Предложить свое виденье того, как будет устроено приложение.

Озвучить используемые инструменты (язык программирования и БД), либо посоветоваться с преподавателем.

Получить (и проверить) доступ в репозиторий

Установка и настройка выбранной БД + ЯП

Смысл данного задания - сделать минимально работоспособный пример (скрипт для командной строки) работы “выбранной БД + ЯП” на выбранном вами языке программирования, продемонстрировать его работоспособность в виде скринкаста и залить в репо. Для того, чтобы исключить на поздних этапах проекта проблемы совместимости.

Скрипт может быть быть просто HelloWorld - не связанным с ИДЗ.

Результат:

На вашем компьютере можно создать и запустить пример (см выше) для выбранной вами пары “Язык программирование” - БД. Приложение должно подключится к БД, записать и прочитать данные из нее.

Работа приложения из пункта выше демонстрируется в виде скринкаста (скринкаст == короткая запись видео с вашего экрана). Не заливайте его в репо (можно с гугл / яндекс диска)

Код приложения выше загружен в репозиторий, в ветку main, каталог hello_world.

Делать для этого PR не нужно.

Docker на данном этапе не нужен.

Use case

Презентация про то, как составлять макет и писать сценарии использования (+типичные ошибки)

Результат размещен на вики в виде одной страницы “Макет и сценарий использования”:

У вас есть формулировки основных сценариев использования приложения (текст, размещенный на вики, а не ссылка на документ) и макета его пользовательского интерфейса (большое изображение), размещенные на вики вашего репозитория.

Макет изображен в виде графа (https://hsto.org/files/026/cab/55a/026cab55a5ad4a1daab209c39715b947.png).

Файл макета загружен в репозиторий под названием ui_mockup.png (jpg, svg), макет вставлен как изображение на вики.

Каждый экран на макете имеет или уникальное осмысленное название или номер, по которому его можно идентифицировать.

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

Все надписи и элементы на макете различимы и читаемы.

Макет включает в себя элементы управления для массового импорта/экспорта данных и построения кастомизируемой статистики.

Вы знаете какие из сценариев использования вы сможете продемонстрировать в рамках прототипа.

На что стоит обратить внимание при составлении макета (типовые ошибки):

Если у вас в макете фигурирует какая-то сущность (пользователь, поставщик, автомобиль, животное, здание ...), которая фигурирует во множественном числе, у нее обязательно должна быть

страница для просмотра одного элемента (страница пользователя, поставщика ...),

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

почти всегда будет в кассу дополнять такую страницу полем “Комментарий”, где пользователи смогут хранить произвольную информацию, которая не укладывается в модель (но это не приглашение использовать это поле в качестве мусорки),

страница поиска элементов по всем полям (поиск пользователей, поставщиков ...) и отображение результатов в виде таблицы .

Если логика вашего приложения подразумевает какие-либо процессы (например - трекинг задач у программистов, почтовые отправления, заказы в Интернет-магазине) или хотя бы переменные статусы (например - у сотрудника могут быть статусы Уволен, Уволился сам, В отпуске, Работает, Сокращен, ), то важно в макете предсмотреть просмотр и поиск по истории изменения состояний статуса с привязкой ко времени.

Как правило, в большинстве проектов нужны интерфейсы поиска сразу по нескольким сущностям (коллекциям) - например, все курьеры, на которых есть Н незакрытых заказов,

Модель данных

Подготовить страницу на вики репозитория под названием “Модель данных”. Результат (на вики):

На вики странице есть два раздела “Нереляционная модель” “Реляционная модель” “Сравнение моделей”, “Вывод”

Нереляционная модель (для вашей СУБД)

Графическое представление модели (сущности и связи, типы данных, коллекции - можно использовать ER-диаграмму, можно json-схему, если она применима к вашему типу СУБД)

Описание назначений коллекций, типов данных и сущностей

Оценка объема информации, хранимой в модели (сколько потребуется памяти, чтобы сохранить объекты, как объем зависит от количества объектов - нужно выразить через переменную (количество одного из видов объектов вашей БД)). У вас должна получится формула - зависимость объема от одной переменной.

Избыточность модели (отношение между фактическим объемом модели и “чистым” объемом данных).. У вас должна получится формула - зависимость избыточности от одной переменной.

Направление роста модели при увеличении количества объектов каждой сущности.

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

Текст запросов

Количество запросов для совершения юзкейсов в зависимости от числа объектов в БД и прочих параметров

Количество задействованных коллекций (если есть)

“Реляционная модель” - Аналог модели данных для SQL СУБД - характеризуется аналогично нереляционной (см. подпункты выше)

“Сравнение моделей”

Удельный объем информации (сколько потребуется памяти, чтобы сохранить объекты, как объем зависит от количества объектов) - где данные занимают больший объем при прочих равных (http://se.moevm.info/doku.php/staff:courses:no_sql_introduction:calculating_data_model_size)

Запросы по отдельным юзкейсам:

Количество запросов для совершения юзкейсов в зависимости от числа объектов в БД и прочих параметров

Количество задействованных коллекций (если есть)

“Вывод” - что лучше, SQL или NoSQL модель

Есть примеры хранения данных в БД.

Прототип*

Подготовить прототипы приложения (“Хранение и представление” и “Анализ”). Результат:

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

Исходники и исполняемые файлы собранного приложения лежат в репозитории, там поставлен тег 0.5 (0.8). Что такое тег - https://git-scm.com/book/ru/v2/%D0%9E%D1%81%D0%BD%D0%BE%D0%B2%D1%8B-Git-%D0%A0%D0%B0%D0%B1%D0%BE%D1%82%D0%B0-%D1%81-%D1%82%D0%B5%D0%B3%D0%B0%D0%BC%D0%B8

Про пользовательский интерфейс, роли и пользователей:

Пожалуйста, не создавайте несколько разных и несвязанных интерфейсов (на разных контейнерах вашей системы) - сделайте один интерфейс для всех ролей и пользователей.

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

Что подразумевает прототип “Хранение и представление” -

приложение запускается,

позволяет просматривать содержимое БД с помощью таблиц / списков

выполняет одну из следующих функций: или позволяет добавление новых элементов данных в БД, или предоставляет интерфейсы для поиска (фильтрации) данных,

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

вы можете продемонстрировать выполнение всех пунктов выше скринкастом (не более двух минут - сключите запись процесса компиляции / загрузки и тд) или работоспособного процесса сборки из репо через docker-compose

Что подразумевает прототип “Анализ” - выполненны требования “Хранение и представление”

приложение разворачивается через docker-compose build --no-cache из репозитория на ubuntu 22.04+,

сервер вашей СУБД добавлен docker-compose.yml как отдельный контейнер( == вы не используете БД извне ваших контейнеров, у вас есть контейнер db), типовые ошибки по данному пункту:

не выставляйте порт БД наружу

дополняйте маппинг портов указанием локального интерфейса везде, например '127.0.0.1:8081:8081'

не монтируйте локальные каталоги, монтируйте volume (если вам нужны исходники / файлы проекта, то лучше копируйте их на этапе сборки образа)

для контейнера СУБД (за исключением memcached и других хранилищ в памяти) обязательно должен использоватся volume, куда будет монитроватся директория с данным СУБД

вместо тега latest указывайте конкретный тег (версию ) для образов

не выности мапинг портов в переменные среды - в этом нет необходимости, его можно захардкодить вполне

добавлена недостающая часть (либо добавление элементов, либо поиск),

поиск элементов реализован следующим образом - для каждого поля сущности есть отдельное поле (или поля) ввода поискового запроса, что позволяет искать по сложным запросам, например “найди всех сотрудников, у которых пол мужской, дата рождения до 15.01.2002, имя - Олег”. Ориентируйтесь на подробные фильтры в интернет-магазинах.

как нелья реализовывать поиск по нескольким атрибутам: в виде одного поля ввода (input) и выпадающего списка / radiobutton с выбором поля, для которого будет использоваться введенный текст

подумайте, а что вам за ваш фильтр скажут на собеседовании / на текущей работе? Если на ум приходят нецензурные слова, возможно стоит доработать механизм фильтрации.

добавлен импорт и экспорт всех данных приложения в машиночитаемом формате (XML, JSON, CSV ....) одним действием (одна кнопка Импорт импортирует данные сразу для всего приложения, одна кнопка Экспорт экспортирует сразу все данные всего приложения), отдельные кнопки для отдельных сущностей делать не нужно.

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

App is ready

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

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

В приложении есть к представлению данных в виде таблиц добавилась serverside пагинация.

В приложение добавлено вычисление и отображение статистики / анализа данных / необходимых вычислений согласно заданию.

Вы можете продемонстрировать это через docker-compose + дистанционно / с помощью скринкаста.

Исходники и исполняемые файлы собранного приложения лежат в репозитории, там поставлен тег 1.0.

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

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

Предоставить пояснительную записку в электронном виде. Результат:

Ваша пояснительная записка полностью соответствует требованиям к оформлению (http://eltech.ru/assets/files/3004_3_ShABLON-kursovika.doc)и содержанию ( описание)

Записка выложена в репозиторий в редактируемом формате и pdf ( в корне репозитория созданы файлы report.pdf и report.odt / report.docx).

Пример хорошей записки https://github.com/moevm/nosql-2017-lib_card/blob/master/%D0%9F%D0%BE%D1%8F%D1%81%D0%BD%D0%B8%D1%82%D0%B5%D0%BB%D1%8C%D0%BD%D0%B0%D1%8F%20%D0%B7%D0%B0%D0%BF%D0%B8%D1%81%D0%BA%D0%B0.pdf

Состав и оформление пояснительной записки

Создайте в корне репозитория два файла report.docx (doc, odt) и report.pdf.

В отчет можно компилировать тексты из предыдущих заданий (но, пожалуйста, следите за их оформлением:).

Для оформления вам пригодятся следующие ссылки:

Шаблон оформления пояснительной записки к ИДЗ (отчета)

Сервис для конвертации markdown (формат вики Github) в docx

Разделы ИДЗ:

Введение

Актуальность решаемой проблемы

Постановка задачи

Предлагаемое решение

Качественные требования к решению

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

Макет UI

Сценарии использования для задачи

импорта данных:

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

как пользователь загружает данные в программу вручную

представления данных

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

анализа данных

какие действия должен сделать пользователь для проведения анализа данных (подсчет средних, статистик и тд)

экспорта данных

как пользователю получить копию хранимых в программе данных в машиночитаемом формате (JSON, XML, CSV ....)

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

Модель данных

Нереляционная модель данных (для вашей СУБД)

Графическое представление

Описание назначений коллекций, типов данных и сущностей

Оценка удельного объема информации, хранимой в модели (сколько потребуется памяти, чтобы сохранить объекты, как объем зависит от количества объектов)

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

Аналог модели данных для SQL СУБД - характеризуется аналогично нереляционной (см. подпункты выше)

Сравнение моделей

Удельный объем информации - где данные занимают больший объем при прочих равных (http://se.moevm.info/doku.php/staff:courses:no_sql_introduction:calculating_data_model_size)

Запросы по отдельным юзкейсам:

Количество запросов для совершения юзкейсов в зависимости от числа объектов в БД и прочих параметров

Количество задействованных коллекций (если есть)

Сложность запроса

Вывод - что лучше, SQL или NoSQL модель

Разработанное приложение

Краткое описание (из каких модулей / контейнеров состоит, какую архитектуру вы использовали)

Использованные технологии

Снимки экрана приложения

Выводы

Достигнутые результаты

Недостатки и пути для улучшения полученного решения

Будущее развитие решения

Приложения

Документация по сборке и развертыванию приложения

Инструкция для пользователя

Литература (обязательно должна быть ссылка на ваш репо)

Возможные вопросы в процессе сдачи

Термины из курса и их понимание

Обоснования решений из ИДЗ

Сравнение с SQL базами данных

Top secret

Mongo

Neo4j

Memcached

ArangoDB

Cassandra

DGraph