docs: refresh all documentation to the current state
CI Pipeline with Test Management / 🧪 Run Tests & Generate Reports (push) Waiting to run
CI Pipeline with Test Management / 🐳 Docker Integration Tests (push) Blocked by required conditions
CI Pipeline with Test Management / 🏗️ Build Docker Image (push) Blocked by required conditions
CI Pipeline with Test Management / 📊 Generate Test Summary (push) Blocked by required conditions
Test Reporting & Gherkin Analysis / 🧪 Run Tests & Generate Reports (push) Waiting to run
Test Reporting & Gherkin Analysis / 📊 Analyze Test Coverage (push) Blocked by required conditions
Test Reporting & Gherkin Analysis / 🔄 Sync with Linear (push) Blocked by required conditions
Test Reporting & Gherkin Analysis / ⚡ Performance Monitoring (push) Blocked by required conditions
CI Pipeline with Test Management / 🧪 Run Tests & Generate Reports (push) Waiting to run
CI Pipeline with Test Management / 🐳 Docker Integration Tests (push) Blocked by required conditions
CI Pipeline with Test Management / 🏗️ Build Docker Image (push) Blocked by required conditions
CI Pipeline with Test Management / 📊 Generate Test Summary (push) Blocked by required conditions
Test Reporting & Gherkin Analysis / 🧪 Run Tests & Generate Reports (push) Waiting to run
Test Reporting & Gherkin Analysis / 📊 Analyze Test Coverage (push) Blocked by required conditions
Test Reporting & Gherkin Analysis / 🔄 Sync with Linear (push) Blocked by required conditions
Test Reporting & Gherkin Analysis / ⚡ Performance Monitoring (push) Blocked by required conditions
- agent docs: Linear (ZEE-*) → Plane (MITHOME-*) everywhere (task tracking, commit examples, workflows, env vars) - testing steering: replace the obsolete Gherkin/Linear reporting with the pre-deploy suite and the CMS test scripts - README: rewrite to Next.js 15, local deploy, Plane, CMS, security monitoring - DOCKER/proto docs: correct dev-stack ports (app 8080, mongo 27018) and Next.js 15 - content-editor-recovery: mark the old 'next steps' as done - mark clearly-obsolete Linear/GitHub-era guides as deprecated (banner) — LINEAR-SYNC, GITHUB-CICD/INTEGRATION, TEST-MANAGEMENT/REPORTING, traceability, sync-status analysis, requirements docs
This commit is contained in:
@@ -1,131 +1,82 @@
|
||||
# mozdIT Bt. Website Development
|
||||
# mozdIT Bt. — Weboldal fejlesztés (websitedev)
|
||||
|
||||
[](https://github.com/your-username/websitedev/actions/workflows/ci.yml)
|
||||
[](./docker-compose.dev.yml)
|
||||
[](https://pm.llmdev.mozdit.hu)
|
||||
[](https://mozdit.hu)
|
||||
Modern Next.js weboldal a mozdIT Bt. számára — webtárhely, email- és DNS-szolgáltatás, magyar IT vállalkozás.
|
||||
|
||||
Modern Next.js 14 website for mozdIT Bt. - Hungarian IT services company specializing in web hosting, email services, and DNS administration.
|
||||
## Stack
|
||||
|
||||
## 🚀 Quick Start
|
||||
- **Frontend**: Next.js 15 (Turbopack), React 19, TypeScript, Tailwind CSS 4
|
||||
- **Tartalom**: JSON-alapú, séma-validált content rendszer (`proto/src/content/`)
|
||||
- **CMS**: saját, dependency-mentes `content-editor.js` (böngészős szerkesztő)
|
||||
- **Backend**: Next.js API routes, MongoDB
|
||||
- **Tesztelés**: Jest, React Testing Library, Playwright (smoke), valódi szervert indító CMS-tesztek
|
||||
- **Deploy**: natív Docker Compose (`deploy.sh`) + Gitea Actions nélkül, lokálisan vezérelt
|
||||
- **Monitoring**: Winston + Loki, plusz `scripts/security-scan.sh` (ntfy riasztással)
|
||||
|
||||
## Gyors indítás
|
||||
|
||||
```bash
|
||||
# Development server
|
||||
# Fejlesztői szerver
|
||||
cd proto && npm run dev
|
||||
|
||||
# Docker development environment
|
||||
# Docker fejlesztői környezet
|
||||
docker-compose -f docker-compose.dev.yml up -d
|
||||
|
||||
# Run tests
|
||||
cd proto && npm run test:all
|
||||
# Teljes pre-deploy tesztkészlet
|
||||
scripts/pre-deploy-tests.sh
|
||||
```
|
||||
|
||||
## 🔄 Dual Sync Architecture
|
||||
## Feladatkezelés (Plane)
|
||||
|
||||
This project uses **separated sync systems** for optimal management:
|
||||
- **Projekt**: [MITHOME](https://pm.llmdev.mozdit.hu) (workspace: `developments`)
|
||||
- **TODO.md**: helyi tükör, a Plane az elsődleges forrás
|
||||
- **Szinkron**: `node plane-sync.js` (Plane → TODO.md)
|
||||
- **Ticket-azonosítók**: `MITHOME-XX`
|
||||
|
||||
### 📊 **Plane Sync (Task Management)**
|
||||
- **Project**: [MITHOME — mozdIT website dev](https://pm.llmdev.mozdit.hu) (workspace: `developments`)
|
||||
- **TODO.md**: Local mirror, Plane is the authoritative source
|
||||
- **Sync**: `node plane-sync.js` (one-way Plane → TODO.md)
|
||||
- **Status Mapping**: `completed` → ✅, `started` → 🔄, `unstarted` → ⏳, `backlog` → 📋
|
||||
## Deploy
|
||||
|
||||
### 🐙 **GitHub Sync (CI/CD)**
|
||||
- **Code Versioning**: Git-based source control
|
||||
- **CI/CD Pipeline**: Automated testing and deployment
|
||||
- **Docker Integration**: Container build and registry
|
||||
- **Deployment**: Docker Compose (deploy.sh)
|
||||
```bash
|
||||
./scripts/deploy_to_stage_on_local.sh # staging: teljes tesztkészlet + push + deploy + smoke
|
||||
./deploy.sh production # éles (szerveren, staging ellenőrzése után)
|
||||
```
|
||||
|
||||
### 🧪 Test Types
|
||||
- **Unit Tests**: Component and logic testing
|
||||
- **Browser Integration**: jsdom + mocked APIs
|
||||
- **Docker Integration**: Real HTTP calls to services
|
||||
- **E2E Tests**: Complete user workflows
|
||||
A CMS „Publikálás" gombja szintén commitol + pushol + deployol (csak a beállított környezetre). Részletek: `.agent/workflows/deploy.md`, `docs/helyi-staging-deploy.md`.
|
||||
|
||||
## 🛠️ Tech Stack
|
||||
## Tartalomkezelés
|
||||
|
||||
- **Frontend**: Next.js 14, TypeScript, Tailwind CSS 4
|
||||
- **Design System**: CSS Variables, Dark Mode, Custom Animations
|
||||
- **Content Management**: JSON-based structured content
|
||||
- **Backend**: Next.js API Routes, MongoDB
|
||||
- **Testing**: Jest, React Testing Library, Docker
|
||||
- **Deployment**: Docker Compose (deploy.sh), native
|
||||
- **Monitoring**: Winston, Loki, Grafana
|
||||
- **Project Management**: Plane, GitHub Issues
|
||||
|
||||
## 📈 Current Status
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
### ✅ Completed Features
|
||||
- [x] Responsive website with modern design
|
||||
- [x] **Design System** with CSS variables, animations, and micro-interactions
|
||||
- [x] **Dark Mode** with system preference detection and manual toggle
|
||||
- [x] **JSON Content Management** - Structured, easily modifiable content system
|
||||
- [x] Contact form with validation & spam protection
|
||||
- [x] Rate limiting and security features
|
||||
- [x] Docker development environment
|
||||
- [x] Comprehensive test suite
|
||||
- [x] CI/CD pipeline with Plane sync integration
|
||||
- [x] Requirements traceability system
|
||||
|
||||
### 🚧 In Progress
|
||||
- [ ] Performance optimization (ZEE-44)
|
||||
- [ ] SEO enhancements
|
||||
- [ ] Analytics integration
|
||||
|
||||
## 🔗 Links
|
||||
|
||||
- **Production**: https://mozdit.hu
|
||||
- **Staging**: https://staging.mozdit.hu
|
||||
- **Plane Project**: https://pm.llmdev.mozdit.hu (workspace: `developments`, project: `MITHOME`)
|
||||
- **Docker Registry**: ghcr.io/your-username/websitedev
|
||||
|
||||
## 📚 Documentation
|
||||
|
||||
### **Sync Systems:**
|
||||
- [Plane Sync Guide](./PLANE-SYNC-GUIDE.md) - Task management with Plane
|
||||
- [GitHub CI/CD Guide](./GITHUB-CICD-GUIDE.md) - Code & deployment pipeline
|
||||
- [Sync Status Analysis](./SYNC-STATUS-ANALYSIS.md) - Current state overview
|
||||
|
||||
### **Development:**
|
||||
- [Test Management Strategy](./TEST-MANAGEMENT.md)
|
||||
- [Traceability Matrix](./TRACEABILITY-MATRIX.md)
|
||||
- [Docker Setup](./DOCKER.md)
|
||||
- [Development Guide](./proto/README.md)
|
||||
|
||||
## 🎨 Design System
|
||||
|
||||
The project uses a comprehensive design system with:
|
||||
|
||||
- **CSS Variables**: Brand colors, spacing, shadows, transitions
|
||||
- **Dark Mode**: Automatic system preference + manual toggle via ThemeProvider
|
||||
- **Animations**: fadeIn, float, pulse, hover effects (lift, scale, glow)
|
||||
- **Components**: Buttons, cards, icons with consistent styling
|
||||
|
||||
## 📝 Content Management
|
||||
|
||||
All website text content is managed through JSON files:
|
||||
A weboldal szövegei és a CMS a `proto/src/content/` JSON-fájljaiból jönnek:
|
||||
|
||||
```
|
||||
proto/src/content/
|
||||
├── types.ts # TypeScript definitions
|
||||
├── index.ts # Content loader utility
|
||||
├── common.json # Shared texts (buttons, labels)
|
||||
└── pages/
|
||||
├── home.json # Homepage content
|
||||
├── about.json # About page content
|
||||
├── services.json # Services page content
|
||||
└── contact.json # Contact page content
|
||||
├── schema.js # közös séma-validátor (Next + CMS)
|
||||
├── types.ts # TypeScript típusok
|
||||
├── index.ts # tartalom-betöltő
|
||||
├── common.json # közös szövegek (gombok, lábléc, a11y)
|
||||
└── pages/ # oldalankénti tartalom (home, about, services, …)
|
||||
```
|
||||
|
||||
**Usage:**
|
||||
Használat:
|
||||
|
||||
```typescript
|
||||
import { content, getPageContent } from '@/content'
|
||||
|
||||
// Access content
|
||||
const aboutContent = content.pages.about
|
||||
const servicesContent = getPageContent('services')
|
||||
const about = content.pages.about
|
||||
```
|
||||
|
||||
## Dokumentáció
|
||||
|
||||
- **Agent-szabályok**: `.agent/AGENTS.md`, `.agent/steering/`, `.agent/workflows/`
|
||||
- **CMS felhasználói útmutató**: `docs/felhasznaloi-utmutato.md` (a CMS-ben a ❓ Súgó is ezt rendereli)
|
||||
- **Plane szinkron**: `PLANE-SYNC-GUIDE.md`
|
||||
- **Staging deploy**: `docs/helyi-staging-deploy.md`
|
||||
- **Gitea runner**: `docs/gitea-runner-telepites.md`
|
||||
|
||||
## Környezetek
|
||||
|
||||
- **Staging**: https://stage.mozdit.hu
|
||||
- **CMS (staging)**: https://cms.stage.llmdev.mozdit.hu
|
||||
- **ntfy (riasztás)**: `st_limidev_security` topic
|
||||
|
||||
## Biztonsági monitoring
|
||||
|
||||
`scripts/security-scan.sh` (cron, 5 percenként) kriptominer/backdoor indikátorokat figyel
|
||||
(álcázott folyamatnevek, `/tmp/.kworkerd`-jellegű maradványok, magas CPU), és találat esetén
|
||||
ntfy push-t küld a `st_limidev_security` topicra.
|
||||
|
||||
Reference in New Issue
Block a user