GitHub Helper

Przegląd

GitHub Helper to aplikacja napisana w .NET, zaprojektowana w celu pomagania użytkownikom w korzystaniu z komend i parametrów Git. Aplikacja korzysta z bazy danych SQLite do przechowywania i pobierania informacji o komendach, parametrach i przykładach.

Spis treści

• Przegląd
• Wymagania funkcjonalne
• Wymagania niefunkcjonalne
• Struktura bazy danych
• Instalacja
• Użycie
• Licencja

Wymagania funckjonalne

• Użytkownik ma dostęp do listy najważniejszych komend Gita.
• Użytkownik ma możliwość przyjrzenia się szczegółom poszczególnych komend.
• Użytkownik może zapoznać się z dokładnym opisem danej komendy.
• Użytkownik może sprawdzić składnię danej komendy.
• Użytkownik może sprawdzić parametry danej komendy.
• Użytkownik może przyjrzeć się kilku przykładom użycia danej komendy.

Wymagania niefunckjonalne

• Aplikacja konsolowa.
• Aplikacja posiada bazę danych.

Struktura bazy danych

Aplikacja korzysta z bazy danych SQLite (GitHub_Helper.db) z następującymi tabelami:

1. KomendyGit: Przechowuje komendy Git.
2. ParametryKomend: Przechowuje parametry dla każdej komendy.
3. PrzykladyKomend: Przechowuje przykłady dla każdej komendy.

Szczegółowy opis struktury bazy danych znajduje się w pliku DATABASE_STRUCTURE.md.

Instalacja

Wykonaj poniższe kroki, aby skonfigurować i uruchomić aplikację:

1. Sklonuj repozytorium

   git clone https://github.com/JaegerMajster/56205_51417_55245.git

2. Przejdź do katalogu projektu

   cd github-helper

3. Otwórz projekt w Visual Studio Otwórz GitHub Helper.csproj w Visual Studio.

4. Przywróć pakiety NuGet Visual Studio powinno automatycznie przywrócić niezbędne pakiety NuGet. Jeśli nie, przywróć je ręcznie, używając:

   dotnet restore

5. Zbuduj projekt Zbuduj projekt, wybierając Build > Build Solution w Visual Studio lub używając polecenia:

   dotnet build

Użycie

Aby uruchomić aplikację, możesz pobrać najnowszą wersję z Releases page lub zbudować i uruchomić ją z kodu źródłowego.

Uruchamianie z kodu źródłowego

Aby uruchomić aplikację z kodu źródłowego, użyj funkcji debugowania Visual Studio lub wykonaj następujące polecenie w terminalu:

dotnet run --project GitHub Helper.csproj

Upewnij się, że plik bazy danych SQLite (GitHub_Helper.db) znajduje się w tym samym katalogu co plik wykonywalny lub podaj właściwą ścieżkę w stringu połączenia w DatabaseConnection.cs.

Uruchamianie z wersji

1. Pobierz najnowszą wersję Pobierz najnowszą wersję z Releases page.

2. Wypakuj pobrane archiwum Wypakuj zawartość pobranego archiwum.

3. Uruchom plik wykonywalny Przejdź do wypakowanego folderu i uruchom plik GitHub Helper.exe.

Licencja

Ten projekt jest licencjonowany na podstawie licencji MIT - zobacz plik LICENSE po więcej szczegółów.