Do Siki
b0df8dd182
- 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.
93 lines
3.4 KiB
Markdown
93 lines
3.4 KiB
Markdown
# mozdIT Bt. Website Development
|
|
|
|
[](https://github.com/your-username/websitedev/actions/workflows/ci.yml)
|
|
[](./docker-compose.dev.yml)
|
|
[](https://linear.app/zeener)
|
|
[](https://mozdit.hu)
|
|
|
|
Modern Next.js 14 website for mozdIT Bt. - Hungarian IT services company specializing in web hosting, email services, and DNS administration.
|
|
|
|
## 🚀 Quick Start
|
|
|
|
```bash
|
|
# Development server
|
|
cd proto && npm run dev
|
|
|
|
# Docker development environment
|
|
docker-compose -f docker-compose.dev.yml up -d
|
|
|
|
# Run tests
|
|
cd proto && npm run test:all
|
|
```
|
|
|
|
## 🔄 Dual Sync Architecture
|
|
|
|
This project uses **separated sync systems** for optimal management:
|
|
|
|
### 🧪 **Linear Sync (Test Management)**
|
|
- **Requirements**: [ZEE-47: Contact Form Validation](https://linear.app/zeener/issue/ZEE-47)
|
|
- **Test Cases**: [ZEE-48: Email Validation](https://linear.app/zeener/issue/ZEE-48), [ZEE-49: Rate Limiting](https://linear.app/zeener/issue/ZEE-49)
|
|
- **Test Execution**: Automatic sync with Linear issues
|
|
- **Traceability**: Requirements → Test Cases → Automated Tests
|
|
|
|
### 🐙 **GitHub Sync (CI/CD)**
|
|
- **Code Versioning**: Git-based source control
|
|
- **CI/CD Pipeline**: Automated testing and deployment
|
|
- **Docker Integration**: Container build and registry
|
|
- **Deployment**: Staging and production via Dokploy
|
|
|
|
### 🧪 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
|
|
|
|
## 🛠️ Tech Stack
|
|
|
|
- **Frontend**: Next.js 14, TypeScript, Tailwind CSS
|
|
- **Backend**: Next.js API Routes, MongoDB
|
|
- **Testing**: Jest, React Testing Library, Docker
|
|
- **Deployment**: Dokploy, Docker
|
|
- **Monitoring**: Winston, Loki, Grafana
|
|
- **Project Management**: Linear, GitHub Issues
|
|
|
|
## 📈 Current Status
|
|
|
|
|
|
|
|
|
|
|
|
### ✅ Completed Features
|
|
- [x] Responsive website with modern design
|
|
- [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 Linear 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
|
|
- **Linear Project**: https://linear.app/zeener
|
|
- **Docker Registry**: ghcr.io/your-username/websitedev
|
|
|
|
## 📚 Documentation
|
|
|
|
### **Sync Systems:**
|
|
- [Linear Sync Guide](./LINEAR-SYNC-GUIDE.md) - Test management with Linear
|
|
- [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)
|