Jednoduché na údržbu

Vytvorte softvér, ktorý budúci vývojári môžu ľahko pochopiť, upraviť a rozšíriť

Jasná štruktúra projektu a modulárna architektúra

Zabezpečujeme, že štruktúra priečinkov je prvá vec, ktorú budúci vývojár posúdi. Používajú sa názorom vedené, konzistentné štruktúry priečinkov (napr. src/components, src/services, src/hooks, src/features).

Čitateľné, predvídateľné štandardy kódu

Píšeme kód pre ľudí, nie len pre kompilátor. Konzistentné názvové konvencie a vzory sa dodržiavajú vo všetkých projektoch. ESLint a Prettier sú nastavené na vynucovanie formátovania prostredníctvom pre-commit hookov ako Husky, čím sa zabezpečuje kvalita kódu od začiatku. Uprednostňujeme typované jazyky, používame TypeScript namiesto JavaScriptu pre lepšiu udržateľnosť. Vždy udržiavame kód čitateľný a spravovateľný, sústredený a malý.

Zdieľaný dizajnový systém / knižnica komponentov

Vyhýbame sa dizajnovému chaosu zakódovaním dizajnových rozhodnutí do znovupoužiteľných kódových komponentov. Používajú sa zavedené systémové komponenty ako ShadCN, Tailwind UI alebo Material UI na zabezpečenie konzistencie naprieč projektmi. Tento prístup pomáha vyhnúť sa písaniu jednorazového UI kódu, pokiaľ to nie je absolútne nevyhnutné, čím sa šetrí čas a zabezpečuje dizajnová konzistencia.

Zabudovaná obchodná logika

Zabezpečujeme, aby obchodná logika nikdy nepatrila do vrstvy UI. Na správne izolovanie a organizovanie obchodnej logiky sa používajú servisné vrstvy, vlastné hooky alebo ovládacie moduly. Pre interakcie s API sa implementujú moderné vzory načítavania dát pomocou SWR, React Query alebo vlastných obalov, ktoré efektívne spravujú caching a stavy chýb. Všetky API volania sú abstrahované do vyhradených servisných priečinkov, ako napríklad services/api/user.ts, čo robí kódovú základňu udržateľnejšou a testovateľnejšou.

Dokumentácia: Udržujte ju ľahkú, ale užitočnú

Nepíšeme romány—len toľko, aby sme rýchlo onboardovali ďalšieho vývojára. README.md je vždy napísané so setupom, env premennými, inštrukciami na nasadenie. Krátke komentáre sú pridané pre zložitú logiku (nepreháňajte s komentármi). TSDoc / JSDoc sa používajú pre verejné metódy. Pridaný je aj CONTRIBUTING.md s pokynmi, ako spustiť testy / konvencie.

Pokrytie testami (iba kritické cesty)

Nepotrebujeme 100% pokrytie, ale potrebujeme kompletné pokrytie tam, kde je zlyhanie nákladné. Jednotkové testy sú prioritizované pre obchodne kritické funkcie. Integračné testy sa používajú pre API koncové body alebo pracovné toky. Vyberajú sa ľahko použiteľné nástroje: Jest + Testing Library (React), Playwright pre e2e. Tak môžeme udržiavať rovnováhu medzi pokrytím a časom na trh.

CI/CD + Automatizácia kvality kódu

Každý commit spúšťa bezpečnostné kontroly. Je nastavený jednoduchý CI/CD pipeline, ktorý robí: Kontroly typov (napr. tsc --noEmit), Lint/format kontroly, Jednotkové testy, Automatické nasadenie na staging. Používajú sa bežné nástroje: GitHub Actions, Docker Compose.

Oddelenie konfigurácie od kódu

Vyhýbame sa hardcodovaným hodnotám = dlhodobá bolesť. Všetky tajomstvá/konfigurácie sú uložené v .env alebo vzdialenej konfigurácii (napr. AWS SSM, Vercel envs). Používa sa nastavenie na základe prostredia (process.env.NODE_ENV). Vyhýbame sa commitovaniu .env.*, API kľúčov, poverení atď. A sú dobre zdokumentované.

Pripravení začať?

Poďme spolu vytvoriť niečo úžasné

Začať