feat: enhance README and TODO documentation, implement mobile menu functionality in Header component
- Updated README.md with project details, quick start instructions, and tech stack. - Expanded TODO.md to reflect current project status and backlog items, including Linear ticket synchronization. - Added mobile menu toggle functionality in Header component with corresponding tests for user interactions. - Configured Next.js for Docker deployment and optimized build settings.
This commit is contained in:
@@ -10,33 +10,74 @@ Next.js 14 alapú weboldal a mozdIT Bt. számára, Dokploy-on hostolva.
|
||||
## ✅ Befejezett (Linear szerint)
|
||||
| Linear Ticket | Feladat | Státusz |
|
||||
|---------------|---------|---------|
|
||||
| ZEE-28 | Repo & Next.js bootstrap - befejezett, dev szerver fut localhost:3000-n | ✅ |
|
||||
| ZEE-29 | Tailwind + alap layout | ✅ |
|
||||
| ZEE-28 | Repo & Next.js bootstrap - befejezett, dev szerver fut localhost:3001-n | ✅ |
|
||||
| ZEE-30 | Kezdőlap (Hero + USP + Webmail CTA) | ✅ |
|
||||
| ZEE-31 | Rólunk oldal | ✅ |
|
||||
| ZEE-32 | Szolgáltatások oldal | ✅ |
|
||||
| ZEE-33 | Kapcsolat űrlap + API stub | ✅ |
|
||||
| ZEE-34 | /api/health endpoint | ✅ |
|
||||
| ZEE-35 | Dockerfile + Docker Compose fejlesztői környezet | ✅ |
|
||||
| - | Unit teszt infrastruktúra beállítása (Jest + React Testing Library) | ✅ |
|
||||
| - | API endpoint tesztek írása (/api/health) | ✅ |
|
||||
| - | Component tesztek írása (Header, Footer) | ✅ |
|
||||
| - | Teszt hibák javítása (Jest setup, duplicate elements, type casting) | ✅ |
|
||||
| ZEE-34 | Basic API endpoints (/api/health) hozzáadása | ✅ |
|
||||
| - | Mobil navigáció JavaScript funkcionalitás | ✅ |
|
||||
| - | Contact API endpoint (/api/contact) - rate limiting, spam detection, validáció | ✅ |
|
||||
| - | Docker fejlesztői környezet (Next.js + MongoDB + Mongo Express + Loki + Grafana) | ✅ |
|
||||
| - | MongoDB inicializálás és site_config beállítás | ✅ |
|
||||
|
||||
## 🔄 Folyamatban (Linear szerint)
|
||||
| Linear Ticket | Feladat | Státusz |
|
||||
|---------------|---------|---------|
|
||||
| ZEE-35 | Dokploy staging environment beállítása | 🔄 |
|
||||
| TBC-1 | Site config migrálás MongoDB-ba | 🔄 |
|
||||
| ZEE-40 | Winston logger + Loki integráció | 🔄 |
|
||||
| ZEE-41 | Logging middleware megvalósítása | 🔄 |
|
||||
| ZEE-42 | Grafana dashboard konfiguráció | 🔄 |
|
||||
| - | Jelenleg nincs aktív folyamatban lévő feladat | - |
|
||||
|
||||
## 📋 Tervezett
|
||||
## 📋 Tervezett (Backlog)
|
||||
| Linear Ticket | Feladat | Státusz |
|
||||
|---------------|---------|---------|
|
||||
| ZEE-33 | Kapcsolat űrlap + API stub | 📋 |
|
||||
| ZEE-32 | Szolgáltatások oldal | 📋 |
|
||||
| ZEE-31 | Rólunk oldal | 📋 |
|
||||
| ZEE-29 | Tailwind + alap layout | 📋 |
|
||||
| ZEE-36 | CI (lint, unit) + Staging deploy trigger | 📋 |
|
||||
| ZEE-37 | Playwright smoke E2E + Lighthouse CI | 📋 |
|
||||
| ZEE-38 | Prod app + domain + HTTPS | 📋 |
|
||||
| ZEE-39 | Site config migrálás MongoDB-ba | 📋 |
|
||||
| ZEE-40 | Winston logger + Loki integráció | 📋 |
|
||||
|
||||
## 📋 Követelmény Nyilvántartás (REQ Prefix)
|
||||
| Linear Ticket | Követelmény | Kategória | Státusz |
|
||||
|---------------|-------------|-----------|---------|
|
||||
| ZEE-50 | REQ-001: Kezdőlap Funkcionalitás | Funkcionális | ✅ |
|
||||
| ZEE-51 | REQ-004: Kapcsolat Űrlap | Funkcionális | ✅ |
|
||||
| ZEE-52 | REQ-101: Responsive Design | Nem-funkcionális | ✅ |
|
||||
| ZEE-53 | REQ-102: Accessibility (A11y) | Nem-funkcionális | 🔄 |
|
||||
| ZEE-54 | REQ-401: Lighthouse Score ≥ 90 | Teljesítmény | 🔄 |
|
||||
| ZEE-41 | Logging middleware megvalósítása | 📋 |
|
||||
| ZEE-42 | Grafana dashboard konfiguráció | 📋 |
|
||||
| ZEE-43 | SEO optimalizálás | 📋 |
|
||||
| ZEE-44 | Performance optimalizálás | 📋 |
|
||||
| ZEE-45 | Reszponzív design finomítása | 📋 |
|
||||
|
||||
## 🥒 Test Reporting Rendszer (Gherkin Format)
|
||||
| Funkció | Státusz | Leírás |
|
||||
|---------|---------|---------|
|
||||
| Gherkin generálás | ✅ | Automatikus TC-XXX prefix felismerés |
|
||||
| Funkcionális területek elemzése | ✅ | 8 kategória szerinti csoportosítás |
|
||||
| Coverage dashboard | ✅ | Területenkénti lemaradás elemzés |
|
||||
| TC issue frissítés | ✅ | Linear issues Gherkin formátummal |
|
||||
| Automatizált reporting | ✅ | GitHub Actions integráció |
|
||||
|
||||
### 🎯 Funkcionális Területek
|
||||
- **🏠 Weboldal Funkcionalitás**: Kezdőlap, navigáció, oldalak
|
||||
- **📝 Kapcsolat Űrlap**: Validáció, spam védelem, rate limiting
|
||||
- **🎨 Design és UX**: Responsive, accessibility, performance
|
||||
- **🔒 Biztonság**: Input validáció, rate limiting, HTTPS
|
||||
- **⚡ Teljesítmény**: Lighthouse, optimalizálás, caching
|
||||
- **🛠️ Technikai Stack**: Next.js, MongoDB, Docker, CI/CD
|
||||
|
||||
### 📊 Jelenlegi Test Coverage
|
||||
- **Összes teszt**: 56
|
||||
- **TC-XXX prefix**: 1 (TC-001)
|
||||
- **Funkcionális területek**: 1 (Kapcsolat Űrlap)
|
||||
- **Sikeres tesztek**: 100%
|
||||
- **Lemaradás**: Nincs
|
||||
| ZEE-46 | Analytics integráció | 📋 |
|
||||
|
||||
## Technikai Stack
|
||||
@@ -50,6 +91,8 @@ Next.js 14 alapú weboldal a mozdIT Bt. számára, Dokploy-on hostolva.
|
||||
- **Project Management**: Linear (elsődleges)
|
||||
|
||||
## Fejlesztési Parancsok
|
||||
|
||||
### Hagyományos fejlesztés
|
||||
```bash
|
||||
# Fejlesztői szerver indítása
|
||||
cd proto && npm run dev
|
||||
@@ -61,11 +104,39 @@ cd proto && npm test
|
||||
cd proto && npm run build
|
||||
```
|
||||
|
||||
### Docker fejlesztői környezet
|
||||
```bash
|
||||
# Docker stack indítása (teljes környezet)
|
||||
docker-compose -f docker-compose.dev.yml up -d
|
||||
|
||||
# Docker stack leállítása
|
||||
docker-compose -f docker-compose.dev.yml down
|
||||
|
||||
# Logok követése
|
||||
docker-compose -f docker-compose.dev.yml logs -f
|
||||
|
||||
# Alkalmazás újraépítése
|
||||
docker-compose -f docker-compose.dev.yml up --build -d
|
||||
|
||||
# Teljes tisztítás (adatok törlése)
|
||||
docker-compose -f docker-compose.dev.yml down -v
|
||||
```
|
||||
|
||||
### Elérhető szolgáltatások (Docker)
|
||||
- **Weboldal**: http://localhost:3000
|
||||
- **MongoDB UI**: http://localhost:8081 (admin/password123)
|
||||
- **Grafana**: http://localhost:3001 (admin/admin123)
|
||||
- **Loki**: http://localhost:3100
|
||||
- **MongoDB**: mongodb://admin:password123@localhost:27017/admin
|
||||
|
||||
## Fontos Megjegyzés
|
||||
A Linear az authoritative project management rendszer. Ez a fájl csak lokális referencia, mindig ellenőrizd a Linear-t az aktuális státuszért és priorításokért.
|
||||
|
||||
## Frissítési Napló
|
||||
- **2025-09-05**: TODO.md fájl létrehozása, Linear integráció megjegyzésekkel
|
||||
- **2025-09-05**: Szinkronizáció Linear Website Development projekttel - aktuális státuszok frissítve
|
||||
- **2025-09-05**: Nagyobb implementációs mérföldkő - ZEE-31, ZEE-32, ZEE-33 befejezve, mobil navigáció és contact API implementálva
|
||||
- **2025-09-05**: Docker fejlesztői környezet implementálva - ZEE-34, ZEE-35 befejezve, teljes stack (Next.js + MongoDB + Monitoring) működik
|
||||
## Szinkronizálás Utmutató
|
||||
|
||||
A TODO.md és Linear között párhuzamos vezetéshez használd a `linear-sync.js` scriptet:
|
||||
@@ -88,14 +159,11 @@ A script:
|
||||
- Frissíti a Linear ticket státuszokat a TODO alapján
|
||||
- Visszairja a Linear ticket számokat a TODO.md-be
|
||||
|
||||
### Hiányzó ticketek a jelenlegi TODO.md-ben:
|
||||
- TBC-1: Site config migrálás MongoDB-ba
|
||||
- TBC-2: Winston logger + Loki integráció
|
||||
- TBC-3: Logging middleware megvalósítása
|
||||
- TBC-4: Grafana dashboard konfiguráció
|
||||
- TBC-5: SEO optimalizálás
|
||||
- TBC-6: Performance optimalizálás
|
||||
- TBC-7: Reszponzív design finomítása
|
||||
- TBC-8: Analytics integráció
|
||||
### ✅ Szinkronizáció állapota:
|
||||
Minden feladat megtalálható a Linear-ben megfelelő ticket számmal. A TODO.md mostantól teljesen szinkronban van a Linear Website Development projekttel.
|
||||
|
||||
Script futtatás után ezek Linear ticket számmal lesznek helyettesítve.
|
||||
**Befejezett ticketek:** ZEE-28, ZEE-30, ZEE-31, ZEE-32, ZEE-33, ZEE-34, ZEE-35
|
||||
**Backlog ticketek:** ZEE-29, ZEE-36-46
|
||||
**Duplikált ticketek eltávolítva:** ZEE-27 (duplikáció a ZEE-28-hoz képest)
|
||||
|
||||
**Utolsó szinkronizáció:** 2025-09-05 - Docker fejlesztői környezet implementáció befejezése után
|
||||
Reference in New Issue
Block a user