auto-claude: subtask-3-5 - Document current features (not planned ones)

This commit is contained in:
Maciej Pienczyn 2026-01-10 09:37:36 +01:00
parent 8c29b7e26b
commit 47b4ca039b

225
README.md
View File

@ -18,19 +18,165 @@ Norda Biznes Hub is a **Flask-powered web platform** built with PostgreSQL, feat
- **User Authentication** - Secure login with email confirmation and role-based access - **User Authentication** - Secure login with email confirmation and role-based access
- **RESTful API** - JSON endpoints for programmatic access to company data - **RESTful API** - JSON endpoints for programmatic access to company data
## Obecne funkcjonalności ## Features
### Wersja 1.0 ### User-Facing Features
- Lista 80 firm członkowskich
- Wyszukiwarka firm (nazwa, opis) #### 🏢 Company Directory & Catalog
- Filtrowanie po kategoriach: - **80 member companies** with 100% coverage of Norda Biznes membership
- IT & Technologie - **6 business categories:** IT, Construction, Services, Production, Trade, Other
- Budowlane - **Comprehensive company profiles** with verified data (NIP, REGON, KRS)
- Usługi - **Detailed information:** Contact details, services, competencies, social media presence
- Produkcja - **Website technical analysis** for each company
- Handel - **Data quality levels:** Basic, enhanced, and complete profiles
- Responsywny design (mobile, tablet, desktop)
- Nowoczesny interfejs użytkownika #### 🔍 Advanced Search & Discovery
- **Multi-mode search system** with AI-powered capabilities
- **Direct lookup:** NIP/REGON exact matching
- **Keyword search:** Company name, description, services, competencies
- **Synonym expansion:** Automatic keyword expansion (e.g., "strony" → www, web, portal)
- **Full-text search:** PostgreSQL FTS with tsvector indexing
- **Fuzzy matching:** pg_trgm for typo tolerance
- **Weighted scoring:** Prioritized results by relevance
#### 💬 AI Chat Assistant
- **Conversational AI** powered by Google Gemini 2.5 Flash
- **Context-aware recommendations** for company discovery
- **Multi-turn conversations** with full history tracking
- **Answer questions** about member companies and services
- **Find companies** by service, competency, or business need
- **Quality assurance:** 15 test cases with 70% pass threshold
- **Rate limiting:** 200 requests/day, 50 requests/hour
#### 🔐 User Authentication & Accounts
- **Secure registration** with email confirmation
- **User profiles** with company affiliation tracking
- **Password reset** functionality
- **Session management** with Flask-Login
- **CSRF protection** on all forms
- **Role-based access** (user vs admin)
#### 🔔 Notifications System
- **Real-time notifications** for user activity
- **Notification types:** New news, news approved/rejected
- **JSON API** for programmatic access
- **Unread count** tracking
### Admin Features (Requires Admin Access)
#### 📰 News Monitoring & Moderation
- **Automated news monitoring** via Brave Search API
- **AI-powered relevance scoring** (0.0-1.0) with Google Gemini
- **News categorization:** News mentions, press releases, awards
- **Admin moderation dashboard** with approve/reject workflow
- **Bulk actions** for efficient moderation
- **Display on company profiles** for approved news
#### 📱 Social Media Audit
- **Track 6 platforms:** Facebook, Instagram, LinkedIn, YouTube, TikTok, Twitter/X
- **Profile verification** and validation
- **Activity monitoring:** Last checked, followers count
- **Missing profile identification** for outreach opportunities
- **Current coverage:** 115 profiles across 53 companies (66% coverage)
- **Batch audit processing** for efficiency
#### 🎯 SEO Dashboard & Audit
- **Comprehensive SEO audits** using Google PageSpeed Insights API
- **Performance scoring** (0-100) for each company website
- **Accessibility scoring** for WCAG compliance
- **Best practices scoring** for web standards
- **On-page SEO analysis:** Meta tags, headings, images
- **Technical SEO checks:** robots.txt, sitemap, canonical tags
- **Historical tracking** of SEO improvements
- **Batch processing** with rate limiting (25,000 req/day)
#### 🏪 Google Business Profile (GBP) Audit
- **Field-by-field completeness checking**
- **Weighted scoring algorithm** (100 points total)
- **AI-powered recommendations** via Google Gemini
- **Historical tracking** of profile improvements
- **Photo requirements analysis**
#### 💻 IT Infrastructure Audit
- **Security posture scoring** (50% weight)
- **Collaboration readiness assessment** (30% weight)
- **Completeness scoring** (20% weight)
- **Maturity level classification**
- **Cross-company collaboration matching**
- **Security elements:** EDR, MFA, Firewall, Backup, DR, VPN, Monitoring
#### 💬 Forum Management
- **Discussion forum** for member engagement
- **Topic and reply moderation**
- **Community discussions**
#### 📅 Calendar Management
- **Events and meetings calendar**
- **Event creation and management**
- **Member calendar access**
#### 👥 User Management
- **User account administration**
- **Permission management**
- **Admin role assignment**
### Technical Features
#### 🔌 RESTful API
- **JSON endpoints** for programmatic access:
- `GET /api/companies` - Companies list
- `GET /api/verify-nip` - NIP verification
- `GET /api/notifications` - User notifications
- `GET /health` - Health check
- **Authentication required** for protected endpoints
#### 🛡️ Security & Rate Limiting
- **Flask-Login** for session management
- **Flask-WTF** for CSRF protection on all forms
- **Flask-Limiter** for rate limiting (200 req/day, 50 req/hour)
- **Secure password hashing**
- **SQL injection protection** via SQLAlchemy ORM
- **XSS protection** via Jinja2 auto-escaping
- **API key management** via environment variables
#### 🗄️ Database Architecture
- **PostgreSQL** primary database with 20+ tables
- **SQLAlchemy 2.0** ORM with advanced features
- **Full-text search** with tsvector indexing
- **Fuzzy matching** with pg_trgm extension
- **JSONB support** for flexible data storage
- **Migration system** for schema versioning
#### 🌍 Multi-Environment Deployment
- **Development:** PostgreSQL via Docker (localhost:5433)
- **Production:** NORDABIZ-01 server (VM 249, 10.22.68.249)
- **Reverse proxy:** NPM on R11-REVPROXY-01
- **SSL/TLS:** Let's Encrypt with auto-renewal
- **Domain:** nordabiznes.pl (DNS in OVH)
- **WSGI:** Gunicorn production server
#### 🔗 External API Integrations
- **Google Gemini AI** - Conversational AI (200 req/day)
- **Google PageSpeed Insights** - SEO audits (25,000 req/day)
- **Google Maps/Places** - Business verification
- **Microsoft Graph API** - Email service
- **KRS Open API** - Polish business registry
- **Brave Search API** - News monitoring (2,000 req/month)
#### ✅ Data Verification & Quality Control
- **NIP verification** via KRS API
- **REGON validation**
- **KRS number verification**
- **Data completeness checks**
- **Quality levels:** Basic, enhanced, complete
- **Automated verification scripts**
#### 🧪 AI Quality Testing Framework
- **Automated AI response evaluation**
- **15 test cases** in 8 business categories
- **70% pass threshold** for quality assurance
- **JSON-based test configuration**
- **Detailed evaluation reports**
## Project Structure ## Project Structure
@ -309,34 +455,41 @@ docker exec -i nordabiz-postgres psql -U nordabiz_app -d nordabiz < database/sch
For more detailed database setup and management, see `database/README.md`. For more detailed database setup and management, see `database/README.md`.
## Planowane rozszerzenia ## Roadmap & Future Enhancements
### Faza 2 - Profile firm While the platform is fully functional and in production, the following features are planned for future releases:
- [ ] Szczegółowe profile każdej firmy
- [ ] Dane kontaktowe (email, telefon, adres)
- [ ] Linki do stron WWW i social media
- [ ] Galeria zdjęć
- [ ] Oferta produktów/usług
### Faza 3 - Networking ### Enhanced Company Profiles
- [ ] System wiadomości między firmami - [ ] Photo galleries for company showcases
- [ ] Tablica ogłoszeń - [ ] Product/service catalog with detailed descriptions
- [ ] Oferty współpracy - [ ] Company achievements and awards timeline
- [ ] Wydarzenia i spotkania networkingowe - [ ] Employee directory and team profiles
### Faza 4 - Deals & Współpraca ### Networking & Collaboration
- [ ] Marketplace dla ofert B2B - [ ] Direct messaging system between member companies
- [ ] System matchingu partnerów biznesowych - [ ] Collaboration opportunities board
- [ ] Wspólne projekty i konsorcja - [ ] Joint project proposals and consortium building
- [ ] Referencje i rekomendacje - [ ] Recommendation and referral system
### Faza 5 - Zaawansowane funkcje ### B2B Marketplace
- [ ] Panel administracyjny - [ ] Dedicated marketplace for B2B offers
- [ ] Logowanie dla członków - [ ] Business partner matching algorithm
- [ ] Newsletter - [ ] RFP/RFQ posting and bidding system
- [ ] Blog / Aktualności - [ ] Contract management tools
- [ ] Statystyki i analytics
- [ ] Integracja z CRM ### Analytics & Reporting
- [ ] Company analytics dashboard
- [ ] Member engagement metrics
- [ ] Platform usage statistics
- [ ] Custom reporting tools
### Integration & Automation
- [ ] Newsletter system for member updates
- [ ] CRM integration capabilities
- [ ] Automated data enrichment workflows
- [ ] Third-party service integrations
**Note:** Features are prioritized based on member feedback and business value. See `CLAUDE.md` for detailed roadmap planning.
## Technology Stack ## Technology Stack