Projekt-konkurs-JGWKBH

Dokumentacja instalacji i uruchomienia projektu konkursowego JGWKBH.

Spis treści

• Wymagania wstępne
• Instalacja i uruchomienie frontendu
• Uruchomienie backendu
• Konfiguracja serwera SI (Ollama)
• Struktura projektu
• Rozwiązywanie problemów

Wymagania wstępne

Przed rozpoczęciem instalacji upewnij się, że masz zainstalowane:

• Node.js (zalecana wersja LTS)
• Visual Studio Code lub inny edytor kodu
• Przeglądarka internetowa (Chrome, Firefox, Edge)

Instalacja i uruchomienie frontendu

1. Pobierz repozytorium projektu "Projekt-konkurs-JGWKBH" i umieść je w wybranym folderze:

git clone https://github.com/PumaYT22/Projekt-konkurs-JGWKBH.git

2. Otwórz folder projektu w Visual Studio Code

3. Otwórz nowy terminal (Ctrl+Shift+`)

4. Przejdź do folderu z aplikacją frontendową:

cd Projekt-konkurs-JGWKBH
cd front
cd apka

5. Zainstaluj wymagane zależności:

npm install tailwindcss @tailwindcss/vite
npm i react-router-dom
npm i vite
npm i

6. Uruchom aplikację w trybie deweloperskim:

npm run dev

7. Otwórz przeglądarkę i przejdź pod adres podany w terminalu (zwykle http://localhost:5173/)

Uruchomienie backendu

1. Otwórz nowy terminal w Visual Studio Code, pozostawiając uruchomiony frontend

2. Przejdź do folderu backendu:

cd Projekt-konkurs-JGWKBH
cd backend

3. Zainstaluj narzędzie nodemon (do automatycznego restartu serwera):

npm i nodemon

4. Utwórz plik konfiguracyjny .env w folderze backend:

ACCESS_TOKEN_SECRET=ssdaads

Ważne: Plik .env zawiera klucze potrzebne do zabezpieczenia aplikacji. W środowisku produkcyjnym należy użyć bardziej złożonego klucza.

5. Uruchom serwer backendu:

npm run start

Poprawne uruchomienie powinno być potwierdzone komunikatem w terminalu. Przykładowy użytkownik z notatkami email: testuser@gmail.com hasło: testuser@123

Konfiguracja serwera SI

Projekt wykorzystuje Ollama jako lokalny serwer SI do przetwarzania danych.

1. Pobierz i zainstaluj Ollama ze strony https://ollama.com/download

2. Po instalacji uruchom aplikację Ollama

3. Opcjonalnie: zainstaluj i skonfiguruj dodatkowe modele SI według potrzeb projektu:

ollama run deepseek-r1:8b

Struktura projektu

Projekt-konkurs-JGWKBH/
├── front/
│   └── apka/
│       ├── public/
│       ├── src/
│       ├── package.json
│       └── ...
├── backend/
│   ├── .env
│   ├── package.json
│   └── ...
└── README.md

Rozwiązywanie problemów

Problem z połączeniem do backendu

• Upewnij się, że backend działa na prawidłowym porcie
• Sprawdź, czy plik .env jest poprawnie skonfigurowany

Problem z uruchomieniem frontendu

• Upewnij się, że wszystkie zależności zostały zainstalowane (npm i)
• Sprawdź logi błędów w konsoli terminala

Problem z Ollama

• Sprawdź, czy Ollama została poprawnie zainstalowana
• Upewnij się, że aplikacja jest uruchomiona w tle

---

Moduły zawarte w projekcie

@capacitor/android@7.1.0

@capacitor/app@7.0.0

@capacitor/cli@7.1.0

@capacitor/core@7.1.0

@capacitor/http@0.0.2

@capacitor/ios@7.1.0

@eslint/js@9.22.0

@tailwindcss/typography@0.5.16

@tailwindcss/vite@4.0.14

@types/react-dom@19.0.4

@types/react@19.0.10

@vitejs/plugin-react@4.3.4

autoprefixer@10.4.21

axios@1.8.3

capacitor@0.5.6

eslint-plugin-react-hooks@5.2.0

eslint-plugin-react-refresh@0.4.19

eslint@9.22.0

globals@15.15.0

moment@2.30.1

postcss@8.5.3

react-dom@19.0.0

react-icons@5.5.0

react-markdown@10.1.0

react-modal@3.16.3

react-router-dom@7.3.0

react-toastify@11.0.5

react@19.0.0

rehype-raw@7.0.0

remark-gfm@4.0.1

tailwindcss@4.0.14

vite@6.2.2

---

W przypadku innych problemów, odwiedź repozytorium projektu lub skontaktuj się z autorami.