Răsfoiți Sursa

Обновить 'README.md'

AndrushaKotov 1 săptămână în urmă
părinte
comite
a73d68df82
1 a modificat fișierele cu 85 adăugiri și 1 ștergeri
  1. 85 1
      README.md

+ 85 - 1
README.md

@@ -1,3 +1,87 @@
 # FreightTransport
 
-Информационная система "Грузоперевозки" - WPF приложение для учёта заказов на перевозку грузов с базой данных PostgreSQL
+# Аннотация
+
+Информационная система «Грузоперевозки» представляет собой настольное WPF-приложение для учёта заказов на перевозку грузов, ведения справочников клиентов, водителей, транспортных средств, грузов, городов и маршрутов. Данные системы хранятся в базе данных PostgreSQL. Приложение поддерживает авторизацию пользователей и разграничение прав доступа по ролям: driver, dispatcher и admin.
+
+# Введение
+
+Основные возможности системы:
+
+- регистрация и авторизация пользователей;
+- разграничение прав доступа по ролям driver, dispatcher и admin;
+- просмотр справочников;
+- просмотр, добавление, редактирование и удаление заказов с учётом роли пользователя;
+- фильтрация и поиск заказов;
+- контроль статусов заказов: «В пути», «Доставлен», «Отменён»;
+- отображение представления просроченных заказов;
+- работа с базой данных в PostgreSQL.
+
+# Назначение и условия применения
+
+Программа предназначена для использования в логистических компаниях, транспортных отделах предприятий и организациях, выполняющих перевозку грузов. Система применяется для централизованного учёта заказов, контроля сроков доставки, ведения справочной информации и распределения функций между водителем, диспетчером и администратором.
+
+Для работы программы необходимы:
+
+- операционная система Windows 10 или выше;
+- установленная СУБД PostgreSQL версии 14-18;
+- наличие пользователя PostgreSQL с правами создания базы данных;
+- установленное приложение ИС «Грузоперевозки»;
+- доступ пользователя к учётной записи в системе.
+
+# Установка
+
+
+### Шаги установки:
+
+1. [ ] Скачайте установочный файл Setup_FreightTransport_v1.0.exe.
+2. [ ] Запустите установочный файл **от имени администратора** (правой кнопкой мыши → «Запуск от имени администратора»).
+3. [ ] Убедитесь, что на компьютере установлена СУБД PostgreSQL версии 14-18.
+4. [ ] ** 0$s%MB3&F6# — пароль пользователя postgres** — он потребуется для создания базы данных.
+5. [ ] Введите пароль пользователя postgres при запросе установщика.
+6. [ ] Дождитесь копирования файлов приложения в каталог `C:\Program Files\ИС Грузоперевозки\`.
+7. [ ] Дождитесь автоматического создания базы данных `freight_db`.
+8. [ ] Убедитесь, что выполнены SQL-скрипты `create_tables.sql`, `create_views.sql` и `insert_test_data.sql`.
+9. [ ] Завершите работу мастера установки.
+10.[ ] Запустите приложение `WpfApp1.exe` из меню «Пуск» или с рабочего стола.
+11.[ ] Установка считается выполненной, если открывается окно авторизации приложения.
+
+# Описание операций
+
+## Вход в систему
+
+1. Запустите приложение `WpfApp1.exe`.
+2. Введите логин и пароль пользователя:
+   - **Администратор**: логин `admin`, пароль `admin123`
+   - **Диспетчер**: логин `dispatcher`, пароль `disp123`
+   - **Водитель**: логин `driver`, пароль `driver123`
+3. Нажмите кнопку входа.
+4. После успешной авторизации система откроет главное окно с доступными разделами.
+
+## Просмотр справочников
+
+Пользователь может открыть справочники. Доступные действия зависят от роли пользователя.
+
+## Работа с заказами
+
+Диспетчер и администратор могут создавать новые заказы, изменять маршрут, груз, клиента, водителя, транспортное средство и статус заказа. Водитель может просматривать доступные ему сведения о заказах.
+
+## Просмотр просроченных заказов
+
+Раздел просроченных заказов показывает заказы, срок выполнения которых нарушен. Данные формируются на основании представления `v_late_orders`.
+
+## Завершение работы
+
+Для завершения работы необходимо закрыть главное окно приложения. При следующем запуске пользователь повторно проходит авторизацию.
+
+# Термины и сокращения
+ ИС Грузоперевозки — Информационная система для учёта и управления грузоперевозками 
+ Водитель — Пользователь с ролью driver, имеющий право просматривать назначенные заказы и справочники в режиме чтения 
+ Диспетчер — Пользователь с ролью dispatcher, имеющий право создавать и редактировать заказы 
+ Администратор — Пользователь с ролью admin, имеющий полный доступ к функциям системы
+ PostgreSQL — Система управления реляционными базами данных, используемая в проекте 
+ WPF — Windows Presentation Foundation, технология создания графических приложений 
+ SQL — Structured Query Language, язык структурированных запросов для работы с базами данных 
+ Git — Система контроля версий для хранения исходного кода 
+ v_late_orders — Представление базы данных для отображения просроченных заказов 
+ v_orders_full — Представление базы данных для отображения полной информации о заказах