Skip to content

README.md

Latest commit

 

History

History
179 lines (120 loc) · 5.22 KB

README.md

File metadata and controls

179 lines (120 loc) · 5.22 KB

Testownik Solvro - Frontend

TypeScript React Next.js TailwindCSS

Twoje narzędzie do nauki na Politechnice Wrocławskiej

🌐 Odwiedź aplikację • 🧑‍💻 Repozytorium backend

📖 O projekcie

Testownik Solvro to platforma edukacyjna stworzona przez KN Solvro dla studentów Politechniki Wrocławskiej. Aplikacja umożliwia tworzenie, rozwiązywanie i udostępnianie quizów, pomagając w przygotowaniu do sesji egzaminacyjnej.

🚀 Uruchomienie lokalne

Wymagania

  • Node.js (zalecana wersja LTS)
  • pnpm (dostarczany z Node.js)

Instalacja

  1. Sklonuj repozytorium

    git clone https://github.com/Solvro/web-testownik.git
cd web-testownik

  2. Zainstaluj zależności

    pnpm install

  3. Uruchom serwer deweloperski

    pnpm run dev

  4. Otwórz przeglądarkę i przejdź do http://localhost:3000

📜 Dostępne skrypty

Komenda Opis
pnpm run dev Uruchamia serwer deweloperski z HMR
pnpm run build Buduje aplikację do produkcji
pnpm run start Uruchamia serwer produkcyjny
pnpm run lint Sprawdza kod za pomocą ESLint
pnpm run format Formatuje kod za pomocą Prettier
pnpm run format:check Sprawdza formatowanie kodu
pnpm run typecheck Sprawdza typy TypeScript

🛠️ Stack technologiczny

🤝 Kontrybucja

Chcesz pomóc w rozwoju Testownika? Let's go!

  1. Sforkuj repozytorium (tylko jeśli jeszcze nie jesteś w teamie testownika)
  2. Stwórz branch dla swojej funkcji (git checkout -b feat/amazing-feature)
  3. Commituj zmiany (git commit -m 'feat: add amazing feature')
  4. Wypchnij branch (git push origin feat/amazing-feature)
  5. Otwórz Pull Request

Aby było nam wszystkim łatwiej stosuj się do tych zasad przy tworzeniu branchy oraz commitów.

🪾 Nazewnictwo branchy

Każdy branch powinien zawierać prefiks określający typ zmiany oraz numer GitHub Issue (jeżeli dotyczy).

Format

<prefix>/<issue>-short-description

Dostępne prefiksy

  • feat/ - nowe funkcje
  • fix/ - poprawki błędów
  • hotfix/ - krytyczne poprawki produkcyjne
  • design/ - zmiany UI/UX
  • refactor/ - poprawa kodu bez zmiany działania
  • test/ - testy
  • docs/ - dokumentacja

Przykłady

feat/123-add-solvro-auth
fix/87-fix-date-display
design/45-new-color-schema
refactor/210-quiz-import-logic
docs/12-add-readme

✍️ Format commitów

Stosujemy standard Conventional Commits, aby się móc później łatwiej połapać.

Format

<type>(opcjonalny scope): opis w czasie teraźniejszym

Typy commitów

  • feat: - nowa funkcjonalność
  • fix: - naprawa błędu
  • docs: - dokumentacja
  • refactor: - poprawa struktury kodu
  • test: - testy
  • chore: - zmiany w konfiguracji, dependency itp.

Przykłady

feat(auth): add login with solvro auth
fix(quiz): correct randomization of questions
docs: update contribution section
refactor(api): simplify fetch wrapper
test(quiz): add missing unit tests

🐞 Zgłaszanie problemów, pomysłów i pytań

Jeśli nie masz pewności czy temat dotyczy frontendu czy backendu, zgłoś go najpierw tutaj.

Jeśli jesteś dość pewien, że sprawa dotyczy wyłącznie backendu (API, baza danych, logika serwera), wtedy wrzuć zgłoszenie w repozytorium backendu: 🧑‍💻 Repozytorium backend.

📬 Kontakt

Stworzone z ❤️ przez KN Solvro dla studentów Politechniki Wrocławskiej

⭐ Jeśli projekt Ci się podoba, zostaw gwiazdkę!