diff --git a/README.md b/README.md index 6d7a011..45be47c 100644 --- a/README.md +++ b/README.md @@ -1,22 +1,51 @@ -// Установка переменных для Conan -set "VS_DIR=C:\PROGRA~1\MICROS~2\2022\COMMUN~1" -set "VSCMD_INSTALL_DIR=%VS_DIR%" -set "VSCMD_VER=17.0" -set "VCToolsVersion=14.44.35207" +# UseCase'ы приложения: -// Короткий путь для конфига -for %I in ("C:\Program Files\Microsoft Visual Studio\2022\Community") do echo %~sI +# Up And Down - система для учета и отслеживания состояния для людей, больных БАР -// Загрузка кастомных сценариев установки -conan export custom_recipes/boost/ --user=up_and_down --channel=stable -conan export custom_recipes/openssl_fix/ --user=up_and_down --channel=stable -conan export custom_recipes/lz4_fix/ --user=up_and_down --channel=stable -conan export custom_recipes/zlib_fix/ --user=up_and_down --channel=stable -conan export custom_recipes/zstd_fix/ --user=up_and_down --channel=stable -conan export custom_recipes/libmysqlclient_fix/ --user=up_and_down --channel=stable +## UseCase №1 +### 1.Название: Зарегистрировать пользователя +### 2.Актор: Новый пользователь +### 3.Цель: Внести данные о новом пользователе в систему +### 4.Предусловия: +* Пользователь с данным login'ом отсутствует в системе +* Пользователь не авторизован в системе +### 5.Основной поток: +* Пользователь заходит в приложение на любую страницу +* Из-за отсутсвия авторизации приложение перенаправляет его на страницу авторизации +* Пользователь кликает по ссылке, ведущей на странице регистрации +* На странице регистрации пользователь вводит логин и пароль +* Пользователь нажимает кнопку "Зарегистрироваться" +* Система выводит сообщение, что пользователь зарегистрирован в приложении +### 6.Альтернативные потоки: +#### А1.Пользователь с таким логином уже есть в системе +* Процедура регистрации проваливается +* Выводится нотификация с сообщением об ошибке по причине наличия такого же логина в системе +#### А2.Пользователь оставил пустым логин или пароль +* При попытке регистрации подсвечиваются незаполненные поля +* Выводится сообщение об ошибке +### 7.Постусловия +* Пользователь с указанным логином сохранен в БД -// Запуск дебага -conan install . -pr ./profiles/debug_profile --output-folder=cmake-build-debug --build=missing - -// Запуск релиза -conan install . -pr ./profiles/release_profile --output-folder=cmake-build-release --build=missing +## UseCase №2 +### 1.Название: Авторизация пользователя +### 2.Актор: Зарегистрированный пользователь +### 3.Цель: Предоставить пользователю возможность получить его данные в виде дневника болезни +### 4.Предусловия: +* Пользователь должен быть зарегистрирован в системе +* Пользователь должен быть не авторизован в системе +### 5.Основной поток: +* Пользователь заходит в приложение на любую страницу +* Из-за отсутствия авторизации приложение перенаправляет его на страницу авторизации +* Пользователь вводит свой логин и пароль +* Пользователь получает токен, который открывает ему доступ к получению собственных данных +### 6.Альтернативные потоки: +#### А1.Введен неправильный логин или неправильный пароль +* Пользователь не получает токен, авторизация провалена +* Выводится сообщение об ошибке +#### А2.Поле логин или пароль оставлены пустыми +* При попытке авторизации не происходит запрос токена. Авторизация провалена +* Пустые поля подкрашиваются, как ошибочно заполненные +* Выводится сообщение об ошибке +### 7.Постусловия +* Сессия пользователя в виде токена сохраняется на сервере +* Пользователь перенаправлен на основную страницу, где выводится его дневник болезни