AlgoVisus

Aplikacja do dbania o Twój wzrok stworzona we współpracy z KN Visus!

📋 O projekcie

Celem projektu jest stworzenie lekkiej aplikacji webowej, która pomoże programistom oraz osobom pracującym przy komputerze dbać o zdrowie oczu. Narzędzie będzie przypominać o regularnych przerwach i dostarczać cenne informacje o higienie wzroku, bazując na wiedzy optometrycznej.

🛠 Technologie

Wymień główne języki i biblioteki.

• Język: TypeScript
• Biblioteki: React, Tailwind, Shadcn
• Narzędzia: PostreSQL

💻 Jak uruchomić (Getting Started)

Instrukcja krok po kroku, jak uruchomić projekt lokalnie.

Wymagania wstępne

• git
• node >= v24.5.0
• python (tylko do instalacji pre-commit)

Instalacja

1. Sklonuj repozytorium:

   git clone https://github.com/KN-Algo/AlgoVisus.git

2. Zainstaluj zależności frontendowe:

   npm install

3. Zainstaluj zależności wymagane do funkcjonowania pre-commit:

   pip install pre-commit

4. Zainstaluj pre-commit w repozytorium:

   pre-commit install

Uruchomienie

Komenda do uruchomienia programu:

npm run dev

Materiały pomocniczne

• Instalacja node przy użyciu nvm (zalecane)
  • windows
  • linux and macos
• Założenia projektowe
• Dokumentacja React
• Dokumentacja Tailwind
• Komponenty Shadcn
• PWA
• React Router

Konwencje nazewnicze

• branchy
• commitów

🤝 Twórcy

Projekt realizowany przez członków KN Algo przy Politechnice Wrocławskiej:

• Adrian Goral
• Imię Nazwisko

Ze wsparciem merytorycznym członków KN Visus przy Politechnice Wrocławskiej:

• Imię Nazwisko

---

Stworzone z ❤️ przez KN Algo oraz KN Visus | Politechnika Wrocławska