IPAY plan.md

IPAY plan.md

Software Requirements Specification

Amazon Clone — Платформа електронної комерції

Історія змін

Зміст

1. Вступ
2. Загальний опис
3. Межі проєкту
4. Функціональні вимоги
5. Use Cases
6. Нефункціональні вимоги
7. Ризики
8. Метрики успіху проєкту
9. Додатки

1. Вступ

1.1. Мета документа

Цей документ визначає повний набір функціональних та нефункціональних вимог до веб-платформи Amazon Clone — системи електронної комерції, розробленої в рамках курсового командного проєкту з дисципліни ASP.NET Core. Документ слугує єдиним джерелом правди для команди розробки, QA та керівництва на всіх етапах життєвого циклу проєкту: планування, реалізація (Scrum-спринти), тестування (NUnit), документування (DocFX/OpenAPI) та захист.

1.2. Обсяг продукту

Amazon Clone — це повнофункціональна веб-платформа електронної комерції, що дозволяє користувачам переглядати товари, формувати кошик, оформлювати замовлення з онлайн-оплатою, залишати відгуки, а адміністраторам — керувати каталогом, замовленнями та користувачами. Проєкт реалізується як командний проєкт із застосуванням методології Scrum, системи контролю версій Git та архітектури Clean / Onion.

1.3. Аудиторія документа

Команда розробників (Backend, Frontend, Full-stack), керівник проєкту, члени комісії з захисту, QA-інженери (в рамках навчального процесу).

1.4. Визначення, акроніми, скорочення

1.5. Референси

• Методичні вказівки щодо виконання курсового командного проєкту з .NET (2026)
• ISO/IEC/IEEE 29148:2018 — Requirements Engineering
• OWASP Top 10 (2025 edition)
• Microsoft .NET Architecture Guides: Clean Architecture, eShopOnWeb
• Закон України «Про захист персональних даних» № 2297-VI

2. Загальний опис

2.1. Перспектива продукту

Amazon Clone розробляється як самостійний навчальний продукт з нуля, проте архітектурні та UX-рішення базуються на кращих практиках сучасних e-commerce платформ. Система складається з клієнтської частини (React SPA), серверної частини (ASP.NET Core Web API) та шару даних (SQL Server / Firebase).

2.2. Класи користувачів та привілеї

2.3. Операційне середовище

2.4. Обмеження дизайну та реалізації

2.5. Припущення та залежності (Assumptions & Dependencies)

3. Межі проєкту

3.1. У межах проєкту (In Scope)

• Повний життєвий цикл e-commerce платформи: каталог, кошик, замовлення, оплата, адмін-панель
• Реєстрація, аутентифікація, авторизація на ролях (Customer, Admin)
• Система відгуків та рейтингів товарів
• Пошук з фільтрацією та пагінацією (Elasticsearch або SQL Full-Text опціонально)
• Адміністративна панель з аналітикою
• Адаптивний UI (mobile-first)
• Unit-тести (NUnit) для бізнес-логіки
• Документація API (Swagger) та кодова документація (DocFX)
• Деплой на хостинг (Azure, AWS або VPS)

3.2. Поза межами проєкту (Out of Scope)

• Нативні мобільні застосунки (iOS/Android) — лише веб-версія (адаптивна)
• Власний платіжний шлюз (еквайринг) — лише інтеграція зі сторонніми провайдерами
• ML-рекомендації товарів (можна додати як stretch-goal, але не в MVP)
• Багатомовність понад uk/en
• Інтеграція зі службами доставки (Nova Poshta API) — лише імітація статусів
• Мікросервісна архітектура — використовується модульний моноліт (Clean Architecture)

4. Функціональні вимоги

Формат: [Пріоритет MoSCoW] ID — Опис → Критерій прийняття (Acceptance Criteria)

4.1. Авторизація та реєстрація

[Must] FR-01 — Реєстрація користувача через email + пароль або OAuth 2.0 (Google). → AC: Пароль: мін. 8 символів, 1 цифра, 1 спецсимвол; підтвердження email; дублікати email заборонені; inline-валідація.

[Must] FR-02 — Авторизація з розподілом ролей (Customer / Admin). → AC: JWT-токен видається терміном 24 год; роль передається в claims; доступ до адмін-роутів захищений політикою [Authorize(Roles = "Admin")].

[Must] FR-03 — Відновлення пароля через email. → AC: Токен скидання дійсний 15 хв, одноразовий; лист надсилається через SMTP (SendGrid/MailKit).

4.2. Каталог товарів

[Must] FR-04 — Перегляд списку товарів з пагінацією (12 товарів на сторінку). → AC: Підтримка server-side пагінації; час відповіді ≤ 300 мс при 1000+ товарах.

[Must] FR-05 — Перегляд деталей товару: назва, опис, ціна, зображення (до 5 фото), категорія, рейтинг, наявність (SKU). → AC: Галерея зображень з навігацією; відображення пов'язаних товарів з тієї ж категорії.

[Must] FR-06 — Пошук та фільтрація товарів за назвою, категорією, ціновим діапазоном, брендом, рейтингом. → AC: Пошук нечутливий до регістру; комбінація фільтрів через LINQ / EF Core; пустий результат — коректне повідомлення.

[Should] FR-07 — Сортування товарів (ціна за зростанням/спаданням, новіші, популярні, рейтинг). → AC: Сортування виконується на рівні запиту до БД (LINQ OrderBy / OrderByDescending).

4.3. Кошик та оформлення замовлення

[Must] FR-08 — Додавання/видалення товарів у кошик зі зміною кількості. → AC: Кошик зберігається в localStorage для гостей та в БД для авторизованих користувачів; оновлення кількості — без перезавантаження; розрахунок загальної суми в реальному часі.

[Must] FR-09 — Оформлення замовлення з вказівкою адреси доставки та контактних даних. → AC: Валідація обов'язкових полів (ПІБ, місто, адреса, телефон); замовлення створюється зі статусом «Pending».

[Must] FR-10 — Оплата замовлення через інтеграцію з LiqPay / Fondy / Stripe (sandbox). → AC: При успішній оплаті статус змінюється на «Paid»; при відхиленні — «Payment Failed» з можливістю повтору; дані картки не зберігаються на сервері (PCI DSS SAQ A).

[Must] FR-11 — Історія замовлень у особистому кабінеті з деталями та статусами. → AC: Список замовлень сортований за датою (новіші перші); детальний перегляд позицій замовлення.

4.4. Відгуки та рейтинги

[Should] FR-12 — Залишення відгуку та оцінки (1–5 зірок) лише після покупки товару. → AC: Перевірка наявності завершеного замовлення з цим товаром; один відгук на товар від користувача; середній рейтинг перераховується автоматично.

[Should] FR-13 — Перегляд відгуків на сторінці товару з пагінацією. → AC: Відображення імені автора, дати, оцінки, тексту; сортування за датою / оцінкою.

4.5. Адміністративна панель

[Must] FR-14 — CRUD категорій товарів (ієрархічна структура: батьківська / дочірня). → AC: Заборона видалення категорії, якщо вона містить товари; деревоподібне відображення.

[Must] FR-15 — CRUD товарів (назва, опис, ціна, зображення, кількість на складі, категорія). → AC: Завантаження зображень на сервер / хмару; валідація формату (JPEG, PNG) та розміру (≤ 5 МБ); м'яке видалення (soft delete).

[Must] FR-16 — Управління замовленнями: перегляд списку, зміна статусу (Pending → Paid → Shipped → Delivered / Cancelled). → AC: Історія зміни статусів зберігається; сповіщення користувачеві при зміні статусу (email / SignalR).

[Must] FR-17 — Управління користувачами: перегляд, блокування/розблокування, призначення ролей. → AC: Блокований користувач не може авторизуватися; збереження причини блокування.

4.6. Особистий кабінет

[Must] FR-18 — Редагування профілю (ПІБ, email, телефон, адреса доставки, аватар). → AC: Email унікальний; валідація телефону за regex; завантаження аватара ≤ 2 МБ.

[Should] FR-19 — Список обраного (Wishlist). → AC: Додавання/видалення товарів; збереження для авторизованих користувачів; можливість перенесення з Wishlist у кошик.

[Could] FR-20 — Push-сповіщення про зміну статусу замовлення (SignalR / Firebase Cloud Messaging). → AC: Real-time оновлення статусу в особистому кабінеті; badge-лічильник нових сповіщень.

5. Use Cases

UC-01: Оформлення покупки

UC-02: Додавання товару адміністратором

UC-03: Блокування користувача

6. Нефункціональні вимоги

6.1. Продуктивність

6.2. Надійність та доступність

6.3. Безпека

6.4. Масштабованість

6.5. Інтерфейс та доступність

6.6. Якість і тестування

6.7. Архітектурні вимоги (специфічні для курсового проєкту)

7. Ризики

8. Метрики успіху проєкту

9. Додатки

9.1. Словник термінів

9.2. Діаграми (для наступної ітерації документа)

• Use Case Diagram (всі актори та сценарії)
• ER-діаграма сутностей (User, Product, Category, Order, OrderItem, Review, Payment)
• Sequence Diagram для флоу оплати (FR-10)
• Component Diagram: React → ASP.NET Core Web API → SQL Server / Firebase
• Deployment Diagram: Azure/AWS/VPS

9.3. Матриця трасування вимог (Traceability Matrix) — шаблон

Матрицю рекомендується вести в GitHub Projects / Jira з живим синхронізуванням.

9.4. Рекомендований розподіл ролей у команді (2–4 особи)