Vítejte v repozitáři Funweek Web! Tento dokument slouží jako přehled důležitých informací pro všechny vývojáře, kteří na projektu pracují nebo se k němu chtějí připojit.
- Supabase – Backend-as-a-Service (auth, databáze, API).
- Next.js – hlavní framework pro frontend i server-side logiku.
- TypeScript - Type-safety
- React – základní UI knihovna.
- Tailwind CSS v4 – pro rychlé a efektivní stylování.
- PNPM – správce balíčků.
Používáme pnpm místo npm nebo yarn, protože je rychlejší, efektivnější a pracuje chytře s diskovým místem.
🔧 Použití je téměř stejné jako u npm – jen místo
npmpíšemepnpm.
pnpm install # Instalace všech závislostí
pnpm add <balík> # Přidání balíčku
pnpm remove <balík> # Odebrání balíčkupnpm devAplikace se spustí obvykle na: http://localhost:3000
- Tailwind je předkonfigurovaný.
- Doporučuje se používat utility-first přístup.
- Dokumentace: https://tailwindcss.com/
Pro přehlednější historii doporučujeme používat Conventional Commits.
Příklad:
feat: přidána nová komponenta headeru
fix: opraveno chování tlačítka v mobilu
refactor: zjednodušena logika ve utils
- feat: nová funkce
- fix: oprava bugů
- refactor: úpravy kódu bez změny chování
- chore: údržba repa, buildu atd.
- docs: změny dokumentace
- style: úpravy formátování, žádný kód
Oficiální specifikace: https://www.conventionalcommits.org/
/src
/app # Hlavní Next.js routing
/components # Sdílené React komponenty
/lib # Pomocné funkce, klienti, služby
/styles # Tailwind a globální styly
Doporučené nástroje:
- ESLint – kontrola kvality kódu
- Prettier – automatické formátování
Spuštění lintu:
pnpm lint- Všechny proměnné prostředí patří do
.env.local(nikdy necommituje!). - Pokud potřebujete novou env proměnnou, napište ostatním vývojářům.
- Vytvořte si větev pojmenovanou dle konvenčních commitů / feature názvů.
- Dodržujte strukturu kódu a formátovací pravidla.
- Pište čistý a čitelný kód.
Pokud vás napadne něco dalšího, co by se mělo do README přidat, klidně aktualizujte nebo navrhněte úpravu! 🚀✨