AddictionTracker

⚙️ Funkcjonalności

• 🔄 Śledzenie postępów w walce z uzależnieniami
• 📅 Wizualizacja dni życia, które potencjalnie można odzyskać
• 💰 Wizualizacja oszczędności wynikających z rezygnacji z kosztownych nawyków
• 🎯 Ustalanie celów i przypomnienia motywacyjne
• 📊 Statystyki, wykresy i historia postępów
• 🔐 Tryb prywatny i lokalne przechowywanie danych (opcjonalnie)

🚀 Rozpoczęcie pracy

Wymagania wstępne

• Node.js (v14 lub nowszy)
• Git

Instalacja

1. Sklonuj repozytorium:

git clone <adres-repozytorium>
cd AddictionTracker

2. ⚠️ WAŻNE: Skonfiguruj ochronę brancha main:

Windows:

.\scripts\setup-hooks.bat

macOS/Linux:

./script/setup-hooks.sh

Uniwersalne (Node.js):

node ./scripts/setup-hooks.js

Uwaga: Ten krok jest obowiązkowy dla wszystkich kontrybutorów! Chroni branch main przed bezpośrednimi pushami.

3. Zainstaluj zależności:

npm install

🔒 Zasady dotyczące wprowadzania zmian w repozytorium

Aby zapewnić wysoką jakość kodu i stabilność głównej gałęzi (main), obowiązują następujące zasady:

• ✅ Każda zmiana trafia do main wyłącznie przez Pull Request (PR)
• ✅ PR musi być zatwierdzony przez co najmniej jedną osobę
• ✅ PR musi przejść wszystkie testy automatyczne (CI/CD)
• ❌ Zakaz force-push do main
• ❌ Zakaz bezpośredniego pushowania do main — nawet przez administratorów

---

🧠 Konwencje nazw commitów

Stosujemy Conventional Commits w celu ułatwienia automatyzacji, generowania changelogów i analizy historii:

Typ	Przeznaczenie
feat	Nowa funkcjonalność
fix	Poprawka błędu
chore	Zmiany techniczne, nie wpływające na funkcje
refactor	Zmiany w kodzie bez zmiany zachowania
docs	Zmiany w dokumentacji
test	Dodanie lub modyfikacja testów
style	Zmiany formatowania, np. lint, spacje
perf	Zmiany wpływające na wydajność
ci	Zmiany w konfiguracji CI/CD
build	Zmiany wpływające na proces budowania
revert	Cofnięcie wcześniejszego commita

Przykłady:

• feat(auth): dodanie logowania przez Google
• fix(api): poprawa błędnego statusu HTTP
• chore: aktualizacja zależności

---

🌿 Konwencje nazw branchy

Nazwy branchy powinny być czytelne, jednoznaczne i zgodne z poniższym wzorcem:

Prefiks	Przeznaczenie
feature/	Nowa funkcjonalność
fix/	Poprawka błędu
chore/	Zmiany techniczne
hotfix/	Krytyczna poprawka na produkcji
refactor/	Refaktoryzacja kodu
docs/	Zmiany w dokumentacji
test/	Zmiany w testach
release/	Przygotowanie wersji produkcyjnej

Przykłady:

• feature/user-registration
• fix/login-redirect
• chore/update-dependencies

---