doplneny diagram a screenshot do README

This commit is contained in:
Igor Miňo 2025-05-17 11:17:47 +02:00
parent dfa51da14b
commit 16fa3d1ed1
2 changed files with 21 additions and 14 deletions

View File

@ -4,7 +4,7 @@
BugReport je webová aplikácia na sledovanie a správu chýb (bug tracking system) s jednoduchým a intuitívnym používateľským rozhraním. Aplikácia umožňuje pridávať, upravovať, kategorizovať a sledovať stav bug reportov pomocou Kanban-štýl rozhrania s drag-and-drop funkcionalitou.
<br /><br /><br />
`<br /><br />``<br />`
## Funkcie
@ -15,6 +15,13 @@ BugReport je webová aplikácia na sledovanie a správu chýb (bug tracking syst
- **Detailný pohľad** - zobrazenie a úprava detailov reportu
- **REST API** - prístup k dátam cez API endpoint
## Diagram stavov pre BUG
<img src="webapp/src/assets/images/FlowDiagram.drawio.svg" />
## Screenshot
<img src="doc/Screenshot_2025-05-17_111345.png" />
## Technológie
### Backend
@ -94,19 +101,19 @@ API je dostupné cez `api.php` endpoint. Všetky požiadavky vracajú JSON odpov
### Dostupné endpointy
| Akcia | Popis | Parametre |
| ----------------- | -------------------------------------- | --------------------------------------------------------------- |
| `help` | Zobrazí nápovedu | - |
| `add` | Pridá nový report | `title`, `description`, `status`, `group`, `priority` |
| `update` | Aktualizuje report | `report_id`, `report_data` (JSON) |
| `delete` | Vymaže report | `report_id` |
| `get` | Získa jeden report | `report_id` |
| `getAll` | Získa všetky reporty | `status` (voliteľné) |
| `getAllGrouped` | Získa reporty zoskupené podľa stavu | `status` (voliteľné) |
| `updateOrdNum` | Aktualizuje poradie reportov | `ordnums` (JSON) |
| `updateStatus` | Aktualizuje stav reportu | `report_id`, `status` |
| `attachmentAdd` | Pridá prílohu k reportu | `report_id`, `attachment_type`, `attachment_content` |
| `attachmentUpdate` | Aktualizuje prílohu | `attachment_id`, `attachment_content` |
| Akcia | Popis | Parametre |
| -------------------- | -------------------------------------- | --------------------------------------------------------------- |
| `help` | Zobrazí nápovedu | - |
| `add` | Pridá nový report | `title`, `description`, `status`, `group`, `priority` |
| `update` | Aktualizuje report | `report_id`, `report_data` (JSON) |
| `delete` | Vymaže report | `report_id` |
| `get` | Získa jeden report | `report_id` |
| `getAll` | Získa všetky reporty | `status` (voliteľné) |
| `getAllGrouped` | Získa reporty zoskupené podľa stavu | `status` (voliteľné) |
| `updateOrdNum` | Aktualizuje poradie reportov | `ordnums` (JSON) |
| `updateStatus` | Aktualizuje stav reportu | `report_id`, `status` |
| `attachmentAdd` | Pridá prílohu k reportu | `report_id`, `attachment_type`, `attachment_content` |
| `attachmentUpdate` | Aktualizuje prílohu | `attachment_id`, `attachment_content` |
| `attachmentGetAll` | Získa všetky prílohy reportu | `report_id` |
### Príklad API volania

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB