|
|
@@ -1,2 +1,122 @@
|
|
|
-# BooksRating
|
|
|
+# Информационная система «Рейтинг книг»
|
|
|
+
|
|
|
+Информационная система «Рейтинг книг» представляет собой настольное приложение, разработанное для хранения и управления информацией о книгах, авторах, тематических метках, пользователях и комментариях. Программа обеспечивает удобную работу с данными посредством графического интерфейса и позволяет выполнять основные операции по добавлению, редактированию, просмотру и удалению записей в базе данных PostgreSQL.
|
|
|
+
|
|
|
+# Введение
|
|
|
+
|
|
|
+Основные возможности системы:
|
|
|
+
|
|
|
+- Ведение списка книг.
|
|
|
+- Хранение информации об авторах.
|
|
|
+- Работа с тематическими метками книг.
|
|
|
+- Управление комментариями пользователей.
|
|
|
+- Управление учетными записями пользователей.
|
|
|
+- Добавление, редактирование и удаление записей.
|
|
|
+- Разграничение прав доступа между администратором и обычным пользователем.
|
|
|
+- Просмотр данных в табличном виде.
|
|
|
+- Хранение информации в базе данных PostgreSQL.
|
|
|
+- Авторизация пользователей.
|
|
|
+
|
|
|
+# Назначение и условия применения
|
|
|
+
|
|
|
+Информационная система «Рейтинг книг» предназначена для ведения базы данных книг и авторов, хранения пользовательских комментариев и организации работы с тематическими метками.
|
|
|
+
|
|
|
+Программа может использоваться в учебных целях для изучения технологий разработки клиент-серверных приложений, работы с базами данных PostgreSQL и организации хранения информации в реляционной форме.
|
|
|
+
|
|
|
+Для работы программы необходимо:
|
|
|
+
|
|
|
+- Операционная система Windows 10 или выше.
|
|
|
+- Установленная платформа .NET 8 Runtime.
|
|
|
+- Сервер PostgreSQL.
|
|
|
+- Созданная база данных со структурой, соответствующей проекту.
|
|
|
+- Доступ к базе данных через сеть или локальное подключение.
|
|
|
+
|
|
|
+# Установка
|
|
|
+
|
|
|
+1. Скачать архив с опубликованной версией программы.
|
|
|
+2. Распаковать архив в выбранную папку.
|
|
|
+3. Убедиться в наличии всех файлов приложения.
|
|
|
+4. Настроить параметры подключения к базе данных PostgreSQL.
|
|
|
+5. Запустить файл `BooksRating.exe`.
|
|
|
+
|
|
|
+Проверка готовности системы:
|
|
|
+
|
|
|
+- [x] PostgreSQL установлен и запущен.
|
|
|
+- [x] База данных создана.
|
|
|
+- [x] Таблицы импортированы.
|
|
|
+- [x] Пользователь базы данных создан.
|
|
|
+- [x] Приложение успешно запускается.
|
|
|
+- [x] Авторизация выполняется корректно.
|
|
|
+
|
|
|
+# Описание операций
|
|
|
+
|
|
|
+## Авторизация
|
|
|
+
|
|
|
+Для входа в систему необходимо указать логин и пароль пользователя. После успешной проверки учетных данных открывается главное окно программы.
|
|
|
+
|
|
|
+## Работа с авторами
|
|
|
+
|
|
|
+Пользователь может:
|
|
|
+
|
|
|
+- Просматривать список авторов.
|
|
|
+- Добавлять новых авторов.
|
|
|
+- Изменять информацию об авторах.
|
|
|
+- Удалять авторов.
|
|
|
+
|
|
|
+## Работа с книгами
|
|
|
+
|
|
|
+Пользователь может:
|
|
|
+
|
|
|
+- Просматривать список книг.
|
|
|
+- Добавлять новые книги.
|
|
|
+- Изменять сведения о книгах.
|
|
|
+- Удалять книги.
|
|
|
+
|
|
|
+## Работа с метками
|
|
|
+
|
|
|
+Пользователь может:
|
|
|
+
|
|
|
+- Просматривать список меток.
|
|
|
+- Добавлять новые метки.
|
|
|
+- Редактировать существующие метки.
|
|
|
+- Удалять метки.
|
|
|
+
|
|
|
+## Работа с комментариями
|
|
|
+
|
|
|
+Пользователь может:
|
|
|
+
|
|
|
+- Просматривать комментарии.
|
|
|
+- Добавлять комментарии к книгам.
|
|
|
+- Изменять текст комментариев.
|
|
|
+- Удалять комментарии.
|
|
|
+
|
|
|
+## Работа с пользователями
|
|
|
+
|
|
|
+Доступна только администратору.
|
|
|
+
|
|
|
+Администратор может:
|
|
|
+
|
|
|
+- Создавать новых пользователей.
|
|
|
+- Изменять данные пользователей.
|
|
|
+- Удалять пользователей.
|
|
|
+- Управлять правами доступа.
|
|
|
+
|
|
|
+# Термины и сокращения
|
|
|
+
|
|
|
+| Термин | Описание |
|
|
|
+|----------|----------|
|
|
|
+| ИС | Информационная система |
|
|
|
+| БД | База данных |
|
|
|
+| СУБД | Система управления базами данных |
|
|
|
+| PostgreSQL | Реляционная система управления базами данных |
|
|
|
+| Пользователь | Учетная запись, имеющая доступ к системе |
|
|
|
+| Администратор | Пользователь с расширенными правами доступа |
|
|
|
+| Автор | Лицо, являющееся создателем книги |
|
|
|
+| Книга | Основной объект хранения информации в системе |
|
|
|
+| Метка | Категория или тематический признак книги |
|
|
|
+| Комментарий | Текстовый отзыв пользователя о книге |
|
|
|
+| CRUD | Операции создания, чтения, изменения и удаления данных |
|
|
|
+| Git | Система контроля версий |
|
|
|
+| README | Документ с описанием проекта и инструкциями по его использованию |
|
|
|
+
|
|
|
|
