aktualizacia README.md a doplnene UTF Emoji ikonky
This commit is contained in:
57
README.md
57
README.md
@ -6,7 +6,7 @@ BugReport je webová aplikácia na sledovanie a správu chýb (bug tracking syst
|
|||||||
|
|
||||||
<br /><br /><br />
|
<br /><br /><br />
|
||||||
|
|
||||||
## Funkcie
|
## 🚀 Funkcie
|
||||||
|
|
||||||
- **Kanban rozhranie** - vizuálne sledovanie stavu bug reportov v štyroch kategóriách (Nezaradené, Čakajúce, Rozpracované, Blokované)
|
- **Kanban rozhranie** - vizuálne sledovanie stavu bug reportov v štyroch kategóriách (Nezaradené, Čakajúce, Rozpracované, Blokované)
|
||||||
- **Drag-and-drop** - jednoduché presúvanie reportov medzi kategóriami
|
- **Drag-and-drop** - jednoduché presúvanie reportov medzi kategóriami
|
||||||
@ -15,23 +15,23 @@ BugReport je webová aplikácia na sledovanie a správu chýb (bug tracking syst
|
|||||||
- **Detailný pohľad** - zobrazenie a úprava detailov reportu
|
- **Detailný pohľad** - zobrazenie a úprava detailov reportu
|
||||||
- **REST API** - prístup k dátam cez API endpoint
|
- **REST API** - prístup k dátam cez API endpoint
|
||||||
|
|
||||||
## Diagram stavov pre BUG
|
## 🔷 Diagram stavov pre BUG
|
||||||
|
|
||||||
<img src="frontend/src/assets/images/FlowDiagram.drawio.svg" />
|
<img src="frontend/src/assets/images/FlowDiagram.drawio.svg" />
|
||||||
|
|
||||||
## Screenshot
|
## 🖼️ Screenshot
|
||||||
<img src="doc/Screenshot_2025-05-17_111345.png" />
|
<img src="doc/Screenshot_2025-05-17_111345.png" />
|
||||||
|
|
||||||
## Technológie
|
## 🖥️ Technológie
|
||||||
|
|
||||||
### Backend
|
### ⚙️ Backend
|
||||||
|
|
||||||
- PHP
|
- PHP
|
||||||
- SQLite databáza
|
- SQLite databáza
|
||||||
- [TPsoft/DBmodel](https://gitea.tpsoft.org/TPsoft.org/DBmodel) - PHP databázové rozšírenie
|
- [TPsoft/DBmodel](https://gitea.tpsoft.org/TPsoft.org/DBmodel) - PHP databázové rozšírenie
|
||||||
- [TPsoft/APIlite](https://gitea.tpsoft.org/TPsoft.org/APIlite) - Jednoduchý nástroj pre zostavenie API
|
- [TPsoft/APIlite](https://gitea.tpsoft.org/TPsoft.org/APIlite) - Jednoduchý nástroj pre zostavenie API
|
||||||
|
|
||||||
### Frontend
|
### 📺 Frontend
|
||||||
|
|
||||||
- [Vue.js 3](https://vuejs.org/) - JavaScript framework
|
- [Vue.js 3](https://vuejs.org/) - JavaScript framework
|
||||||
- [Vue Router](https://router.vuejs.org/) - smerovanie v aplikácii
|
- [Vue Router](https://router.vuejs.org/) - smerovanie v aplikácii
|
||||||
@ -40,17 +40,24 @@ BugReport je webová aplikácia na sledovanie a správu chýb (bug tracking syst
|
|||||||
- [Mitt](https://github.com/developit/mitt) - knižnica pre správu udalostí
|
- [Mitt](https://github.com/developit/mitt) - knižnica pre správu udalostí
|
||||||
- [Vite](https://vitejs.dev/) - build nástroj
|
- [Vite](https://vitejs.dev/) - build nástroj
|
||||||
|
|
||||||
## Štruktúra projektu
|
## 🌳 Štruktúra projektu
|
||||||
|
|
||||||
```
|
```
|
||||||
BugReport/
|
BugReport/
|
||||||
├── backend/ # Backend aplikácia (PHP)
|
├── backend/ # Backend aplikácia (PHP)
|
||||||
│ ├── src/ # Zdrojový kód
|
|
||||||
│ ├── config/ # Konfigurácia aplikácie
|
│ ├── config/ # Konfigurácia aplikácie
|
||||||
│ └── public/ # Vstupný bod aplikácie
|
│ ├── public/ # Vstupný bod aplikácie, tu nasmerovat vo webserveri DOCUMENT ROOT
|
||||||
|
│ ├── scripts/ # Skripty pre pred-spracovanie, build a ine
|
||||||
|
│ ├── src/ # Zdrojový kód
|
||||||
|
│ │ ├── Models/ # Classy pre jednotlive DB tabulky pouziva TPsoft\DBmodel
|
||||||
|
│ │ ├── API.php # Logika pre API BugReport pouziva TPsoft\APIlite
|
||||||
|
│ │ ├── Init.php # Inicializacia pripojenia k DB, kontroly a iné
|
||||||
|
│ │ └── Maintenance.php # Údržba pre projekt, zatiaľ hlavne pre upgrade databazovej štruktúry, používa \TPsoft\DBmodel\Maintenance
|
||||||
|
│ └── test/ # Testovacie skripty
|
||||||
├── data/ # Dáta aplikácie
|
├── data/ # Dáta aplikácie
|
||||||
│ ├── attachments/ # Súborové uložisko príloh
|
│ ├── attachments/ # Súborové uložisko príloh
|
||||||
│ └── database.db # SQLite databáza
|
│ └── database.db # SQLite databáza
|
||||||
|
├── doc/ # Dokumentácia a iné súbory počas vývoja
|
||||||
└── frontend/ # Frontend aplikácia (Vue.js)
|
└── frontend/ # Frontend aplikácia (Vue.js)
|
||||||
├── public/ # Statické súbory
|
├── public/ # Statické súbory
|
||||||
├── scripts/ # Skripty pre build
|
├── scripts/ # Skripty pre build
|
||||||
@ -65,21 +72,22 @@ BugReport/
|
|||||||
└── router.js # Vue Router konfigurácia
|
└── router.js # Vue Router konfigurácia
|
||||||
```
|
```
|
||||||
|
|
||||||
## Inštalácia a spustenie
|
## 🛠️ Inštalácia a spustenie
|
||||||
|
|
||||||
### Požiadavky
|
### 📋 Požiadavky
|
||||||
|
|
||||||
- PHP 7.4 alebo novší
|
- PHP 8.2 alebo novší
|
||||||
- Webový server (Apache, Nginx)
|
- Webový server (Apache, Nginx)
|
||||||
- Node.js a npm pre vývoj frontendu
|
- Node.js a npm pre vývoj frontendu
|
||||||
|
|
||||||
### Backend
|
### ⚙️ Backend
|
||||||
|
|
||||||
1. Skopírujte súbory do webového adresára
|
1. Skopírujte súbory do webového adresára
|
||||||
2. Uistite sa, že adresár`data` má práva na zápis
|
2. Uistite sa, že adresár `data` má práva na zápis
|
||||||
|
3. Nastavte DOCUMENT ROOT na adresár `backend/public`
|
||||||
3. Prístup k aplikácii cez webový prehliadač
|
3. Prístup k aplikácii cez webový prehliadač
|
||||||
|
|
||||||
### Frontend (pre vývoj)
|
### 📺 Frontend (pre vývoj)
|
||||||
|
|
||||||
1. Prejdite do adresára`frontend`
|
1. Prejdite do adresára`frontend`
|
||||||
2. Nainštalujte závislosti:
|
2. Nainštalujte závislosti:
|
||||||
@ -95,11 +103,11 @@ BugReport/
|
|||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
## API dokumentácia
|
## 📖 API dokumentácia
|
||||||
|
|
||||||
API je dostupné cez `api.php` endpoint. Všetky požiadavky vracajú JSON odpoveď.
|
API je dostupné cez `API.php` endpoint fyzicky umiestnený v DOCUMENT ROOT `backend/public/API.php`. Všetky požiadavky vracajú JSON odpoveď.kompletnú a aktuálnu dokumentáciu je možné získať aj HTML formáte `API.php?format=html`.
|
||||||
|
|
||||||
### Dostupné endpointy
|
### 🚏 Dostupné endpointy
|
||||||
|
|
||||||
| Akcia | Popis | Parametre |
|
| Akcia | Popis | Parametre |
|
||||||
| -------------------- | -------------------------------------- | --------------------------------------------------------------- |
|
| -------------------- | -------------------------------------- | --------------------------------------------------------------- |
|
||||||
@ -116,7 +124,7 @@ API je dostupné cez `api.php` endpoint. Všetky požiadavky vracajú JSON odpov
|
|||||||
| `attachmentUpdate` | Aktualizuje prílohu | `attachment_id`, `attachment_content` |
|
| `attachmentUpdate` | Aktualizuje prílohu | `attachment_id`, `attachment_content` |
|
||||||
| `attachmentGetAll` | Získa všetky prílohy reportu | `report_id` |
|
| `attachmentGetAll` | Získa všetky prílohy reportu | `report_id` |
|
||||||
|
|
||||||
### Príklad API volania
|
### 🔍 Príklad API volania
|
||||||
|
|
||||||
```javascript
|
```javascript
|
||||||
// Získanie všetkých reportov
|
// Získanie všetkých reportov
|
||||||
@ -133,7 +141,7 @@ fetch('api.php?action=add', {
|
|||||||
.then(data => console.log(data));
|
.then(data => console.log(data));
|
||||||
```
|
```
|
||||||
|
|
||||||
## Stavy reportov
|
## 🏗️ Stavy reportov
|
||||||
|
|
||||||
| ID | Stav |
|
| ID | Stav |
|
||||||
| -- | ------------- |
|
| -- | ------------- |
|
||||||
@ -143,7 +151,7 @@ fetch('api.php?action=add', {
|
|||||||
| 3 | Blokované |
|
| 3 | Blokované |
|
||||||
| 4 | Vyriešený |
|
| 4 | Vyriešený |
|
||||||
|
|
||||||
## Priority reportov
|
## 📣 Priority reportov
|
||||||
|
|
||||||
| ID | Priorita |
|
| ID | Priorita |
|
||||||
| -- | --------- |
|
| -- | --------- |
|
||||||
@ -152,13 +160,16 @@ fetch('api.php?action=add', {
|
|||||||
| 2 | Vysoká |
|
| 2 | Vysoká |
|
||||||
| 3 | Kritická |
|
| 3 | Kritická |
|
||||||
|
|
||||||
## Skupiny reportov
|
## 🕸️ Skupiny reportov
|
||||||
|
|
||||||
- `cp` - Control Panel
|
- `cp` - Control Panel
|
||||||
- `task` - Task.Platon.sk
|
- `task` - Task.Platon.sk
|
||||||
- `websiteip` - WebsiteIP
|
- `websiteip` - WebsiteIP
|
||||||
- `antispam` - Antispam
|
- `antispam` - Antispam
|
||||||
|
|
||||||
## Licencia
|
## ✨ Plánované vylepšenia - Planned Features
|
||||||
|
- Skupiny reportov v samostatnej tabuľke s CRUD manažmentom
|
||||||
|
|
||||||
|
## ⚖️ Licencia
|
||||||
|
|
||||||
Tento projekt je licencovaný pod [MIT licenciou](https://opensource.org/licenses/MIT).
|
Tento projekt je licencovaný pod [MIT licenciou](https://opensource.org/licenses/MIT).
|
||||||
|
|||||||
Reference in New Issue
Block a user