shinya/Knihovna
4
4
Fork 1
Code Issues 1 Pull Requests 1 Actions Packages Projects Releases Wiki Activity

Edited README

Browse Source
This commit is contained in:
shinya 2025-10-13 12:27:23 +02:00
parent 8c095470b6
commit 1239957bae
1 changed files with 14 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,7 +1,5 @@
# Knihovna # Knihovna
# Jak přidávat vaši práci
## Struktura projektu ## Struktura projektu
Projekt je organizován do několika klíčových částí: Projekt je organizován do několika klíčových částí:
@ -29,15 +27,18 @@ Knihovna/
## Popis hlavních souborů ## Popis hlavních souborů
### `./src/` ### `./src/`
- Každá **funkce** nebo **část logiky** musí být implementována **v samostatném souboru**. - Každá **funkce** nebo **část logiky** musí být implementována **v samostatném souboru**.
- Například funkci pro vyhledávání knih uložte do souboru `VyhledavaniKnih.cs`. - Například funkci pro vyhledávání knih uložte do souboru `VyhledavaniKnih.cs`.
- Tento přístup zajišťuje přehlednost, modularitu a snadné testování. - Tento přístup zajišťuje přehlednost, modularitu a snadné testování.
### `Database.cs` ### `Database.cs`
- Obsahuje **definici tabulek** a **datových struktur**, které reprezentují databázi (např. `Knihy`, `Ctenari`, `Vypujcky`). - Obsahuje **definici tabulek** a **datových struktur**, které reprezentují databázi (např. `Knihy`, `Ctenari`, `Vypujcky`).
- Není vhodné měnit strukturu bez předchozí domluvy s ostatními členy týmu, protože soubor je sdílený v rámci celého projektu. - Není vhodné měnit strukturu bez předchozí domluvy s ostatními členy týmu, protože soubor je sdílený v rámci celého projektu.
### `Program.cs` ### `Program.cs`
- Slouží jako **hlavní vstupní bod** aplikace. - Slouží jako **hlavní vstupní bod** aplikace.
- Zde se spouští program, načítají data a volají funkce z adresáře `src`. - Zde se spouští program, načítají data a volají funkce z adresáře `src`.
- Tento soubor zajišťuje propojení všech částí projektu. - Tento soubor zajišťuje propojení všech částí projektu.
@ -46,16 +47,18 @@ Knihovna/
## Postup při přidávání vaší práce ## Postup při přidávání vaší práce
### 1️⃣ Klonování repozitáře ### Klonování repozitáře
Stáhněte si projekt lokálně pomocí GITu: Stáhněte si projekt lokálně pomocí GITu:
```bash ```bash
git clone https://gitea.homework.zip/shinya/Knihovna.git git clone https://gitea.homework.zip/shinya/Knihovna.git
``` ```
Tímto příkazem vytvoříte lokální kopii projektu na vašem počítači. Tímto příkazem vytvoříte lokální kopii projektu na vašem počítači.
## Úpravy a implementace ## Úpravy a implementace
Vytvořte nebo upravte soubory v adresáři ./src/. Vytvořte nebo upravte soubory v adresáři ./src/.
Dodržujte strukturu projektu a konvence psaní kódu. Dodržujte strukturu projektu a konvence psaní kódu.
@ -63,6 +66,7 @@ Dodržujte strukturu projektu a konvence psaní kódu.
Průběžně testujte své změny (např. pomocí dotnet run). Průběžně testujte své změny (např. pomocí dotnet run).
## Commit a push ## Commit a push
Jakmile máte změny hotové, proveďte následující příkazy: Jakmile máte změny hotové, proveďte následující příkazy:
```bash ```bash
@ -70,6 +74,7 @@ git add .
git commit -m "Implementace funkce vyhledávání knih" git commit -m "Implementace funkce vyhledávání knih"
git push git push
``` ```
Tímto nahrajete změny zpět na server. Tímto nahrajete změny zpět na server.
Pozor: Před odesláním změn vždy nejprve stáhněte aktuální verzi projektu: Pozor: Před odesláním změn vždy nejprve stáhněte aktuální verzi projektu:
@ -77,9 +82,11 @@ Pozor: Před odesláním změn vždy nejprve stáhněte aktuální verzi projekt
```bash ```bash
git pull git pull
``` ```
- a vyřešte případné konflikty, pokud se vyskytnou. - a vyřešte případné konflikty, pokud se vyskytnou.
## Zadání projektů ## Zadání projektů
V adresáři ./docs se nachází zadání pro jednotlivé týmy. V adresáři ./docs se nachází zadání pro jednotlivé týmy.
Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuje: Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuje:
@ -114,10 +121,10 @@ Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuj
## Funkce ## Funkce
- GetBooks() param. filter wrapper function, pick if by name or author - GetBooks() param. filter wrapper function, pick if by name or author
- GetBooksByAuthor() param. filter - GetBooksByAuthor() param. filter
- GetBooksByName() param. filter - GetBooksByName() param. filter
- GetStolenBooks() param. filter - GetStolenBooks() param. filter
- GetAvailableBooks() param. filter - GetAvailableBooks() param. filter
- GetBorrowedBooks() param. userID - GetBorrowedBooks() param. userID
- GetBookInfo() param. knihaID - GetBookInfo() param. knihaID
- AddBook() param. KnihaInfo - AddBook() param. KnihaInfo