Руководство системного программиста
Общие сведения о программе
Программный комплекс для ведения инвестиционного портфеля в онлайн-сервисе Steam предназначен для эффективного отслеживания и анализа инвестиций в игровые предметы в онлайн-сервисе Steam. Он обеспечивает удобный способ мониторинга, а также предоставляет основные статистические данные для принятия взвешенных решений.
Инструментальные средства:
1) язык программирования: C#;
2) реализация веб-сервера с помощью технологии ASP.NET Core;
3) реализация интерфейса настольного приложения с помощью технологии Avalonia;
4) система управления базами данных SQL Server.
Системные требования указаны в таблице ниже.
Системные требования | ||
---|---|---|
Минимальные | Рекомендованные | |
Процессор | Intel Core i3 10 поколения / AMD Ryzen 3 первого поколения или выше | Intel Core i5 10 поколения / AMD Ryzen 5 первого поколения или выше |
Объём оперативной памяти | 4096 Мб или больше | 8192 Мб или больше |
Структура программы
1) модуль «Архив», который предоставляет возможность хранения предыдущих инвестиционных позиций, что обеспечивает историческую перспективу инвестиций;
2) модуль «Активы», обеспечивающий интерфейс для отслеживания и управления текущими активами в портфеле инвестиций;
3) модуль «Инвентарь», предоставляющий возможность просмотра своего инвентаря и динамики стоимости предметов в нём;
4) модуль «Профиль», дающий пользователям возможность просмотреть данные об аккаунте, а также изменить финансовую цель, валюту или стартовую страницу.
Настройка программы
Для запуска веб-серверной части программного комплекса необходимо выполнить следующие действия:
1) скачать исходный код программы на сервер;
2) настроить обратный прокси Nginx;
3) запустить приложение в контейнере Docker;
Для установки и настройки настольной программы необходимо выполнить следующие действия:
1) скачивание установочного файла;
Сохраните установочный файл на вашем компьютере.
2) запуск установки;
Дважды щелкните по файлу для запуска процесса установки.
3) приветствие;
После запуска установки появится приветственное окно. На этом этапе прочитайте информацию, предоставленную разработчиком программы.
4) выбор директории установки;
Выберите папку, в которую вы хотите установить программу. Обычно используется предложенная по умолчанию директория.
5) установка;
Нажмите "Установить", чтобы начать процесс установки. Подождите, пока установка не завершится. Это может занять некоторое время.
6) завершение установки;
После завершения установки нажмите "Финиш". Теперь программа должна быть установлена на вашем компьютере.
7) запуск программы.
Найдите ярлык на рабочем столе или в меню "Пуск" и дважды щелкните по нему, чтобы запустить программу.
Проверка программы
Перед началом использования рекомендуется выполнить проверку программы, используя тестовые данные из таблицы ниже.
1) тестовый импорт данных: введите тестовые данные для проверки корректности обработки информации во всех модулях;
2) сравнение результатов: убедитесь, что отображаемые результаты соответствуют ожидаемым значениям.
№ теста | Входные данные | Вводимое значение | Ожидаемая реакция программы |
---|---|---|---|
1 | Название группы | «Новая группа» | Добавление новой группы в активы |
2 | Название группы | «Новая группа архива» | Добавление новой группы в архив |
3 | Группа, предмет из списка, количество, цена покупки | «Новая группа», «Набор коллекции Anubis», 12, 23.76 | Добавление нового актива |
4 | Группа, предмет из списка, количество, цена покупки, цена продажи | «Новая группа архива», «Набор коллекции Anubis», 12, 20.20, 24.24 | Добавление нового элемента архива |
5 | Группа, предмет из списка, количество, цена продажи | «Новая группа архива», «Набор коллекции Anubis», 10, 50 | Добавление нового элемента архива |
6 | Финансовая цель | «100000» | Изменение финансовой цели на 100000 |
7 | Валюта | «Доллар» | Изменение текущей валюты на «Доллар» |
8 | Стартовая страница | «Профиль» | Изменение текущей страницы на «Профиль» |
Дополнительные возможности
1) экспорт данных: возможность выгрузки данных об инвестиционных позициях в формат Excel для последующего анализа во внешних инструментах;
2) смена темы оформления: возможность изменить цвета оформления программы на вкладке «Настройки».
Сообщения системному программисту
В настольной программе, как и на веб-сервере, работает детальное логирование для отслеживания ошибок и проблем во время работы.
Руководство программиста
Назначение и условия применения программы
Программный комплекс предназначен для отслеживания и анализа инвестиций в онлайн-сервисе Steam. Основные функции программы включают в себя мониторинг портфеля и статистический анализ инвестиционных позиций. Условия применения включают:
1) системные требования: указаны в таблице ниже.
2) доступ к интернету для взаимодействия с веб-сервером приложения, а также API онлайн-сервиса Steam;
3) корректная установка и настройка программного комплекса (веб-серверной части и настольного приложения).
Системные требования | ||
---|---|---|
Минимальные | Рекомендованные | |
Процессор | Intel Core i3 10 поколения / AMD Ryzen 3 первого поколения или выше | Intel Core i5 10 поколения / AMD Ryzen 5 первого поколения или выше |
Объём оперативной памяти | 4096 Мб или больше | 8192 Мб или больше |
Характеристики программы
Веб-серверная часть программного комплекса реализована на языке C# с использованием фреймворка ASP.NET Core.
Запуск серверной части включает в себя настройку обратного прокси Nginx и запуск контейнера Docker.
Настольная программа реализована на языке C# с использованием технологии создания графического интерфейса Avalonia. Основные характеристики включают:
1) четыре основные функциональные части: «Архив», «Активы», «Инвентарь» и «Профиль»;
2) интерфейс для взаимодействия с данными и отображения статистики.
Обращение к программе
Программа вызывается через выполнение исполняемого файла после установки. Взаимодействие с программой осуществляется с использованием элементов интерфейса, таких как кнопки и поля ввода.
Входные и выходные данные
Входные данные:
1) аккаунт Steam;
2) название предмета;
3) название группы;
4) цвет группы;
5) описание группы;
6) финансовая цель;
7) валюта;
8) стоимость покупки предмета;
9) количество купленных предметов;
10) стоимость продажи предмета (если предмет уже продан).
Выходные данные:
1) список групп активов и архива;
2) список активов;
3) список предметов в архиве;
4) список предметов в инвентаре;
5) график стоимости предмета;
6) график прибыльности группы активов;
7) показатели прибыли в относительных и абсолютных значениях;
8) статистика по инвентарю;
9) список позиций в Excel файле.
Руководство оператора
Назначение программы
Программный комплекс для ведения инвестиционного портфеля в онлайн-сервисе Steam предназначен для мониторинга и анализа инвестиционного портфеля. Его функции включают в себя отслеживание изменений в портфеле и предоставление статистической информации для принятия решений.
Условия выполнения программы
Для успешного выполнения программы необходимо удовлетворение системных требований, указанных в таблице ниже.
Системные требования | ||
---|---|---|
Минимальные | Рекомендованные | |
Процессор | Intel Core i3 10 поколения / AMD Ryzen 3 первого поколения или выше | Intel Core i5 10 поколения / AMD Ryzen 5 первого поколения или выше |
Объём оперативной памяти | 4096 Мб или больше | 8192 Мб или больше |
Выполнение программы
Шаги для загрузки, запуска и выполнения программы:
1) Удостоверьтесь, что система соответствует минимальным требованиям.
2) Запустите программу, используя ярлык на рабочем столе или из меню программ.
3) Выполняйте действия в соответствии с предоставленным интерфейсом.
4) Закройте программу по завершению работы.
Сообщения оператору
Примеры сообщений, которые могут возникнуть в ходе выполнения программы:
1) подтверждение удаления группы;
«Вы уверены, что хотите удалить группу: «[название группы]»?», нажатие кнопки «Ок» приведёт к удалению группы, нажатие кнопки «Отмена» закроет диалоговое окно без удаления группы;
2) подтверждение добавления группы;
«Вы уверены, что хотите добавить группу: «[название группы]»?», нажатие кнопки «Ок» приведёт к добавлению новой группы, нажатие кнопки «Отмена» закроет диалоговое окно без добавления группы;
3) подтверждение удаления актива.
«Вы уверены, что хотите удалить актив: «[название актива]»?», нажатие кнопки «Ок» приведёт к удалению актива, нажатие кнопки «Отмена» закроет диалоговое окно без удаления актива.
Помимо этого, в ходе выполнения программы могут появляться уведомления с таким содержанием:
1) «Авторизация прошла успешно» при входе в аккаунт;
2) «Вы вышли из аккаунта» при выходе из аккаунта;
3) «Файл «[название файла]» успешно сохранён» при сохранении файла.