From ee250290d08b783d0451d5a0ec3dfd5fd9fd0545 Mon Sep 17 00:00:00 2001 From: Maciej Pienczyn Date: Sat, 10 Jan 2026 09:57:58 +0100 Subject: [PATCH] auto-claude: subtask-4-3 - Polish formatting and presentation --- README.md | 147 ++++++++++++++++++++++++++++-------------------------- 1 file changed, 75 insertions(+), 72 deletions(-) diff --git a/README.md b/README.md index bf7b787..9643767 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,8 @@ - [Contributing](#contributing) - [Troubleshooting](#troubleshooting) - [Resources & Documentation](#resources--documentation) -- [Contact](#dane-kontaktowe-norda-biznes) +- [Roadmap & Future Enhancements](#roadmap--future-enhancements) +- [Contact](#contact) --- @@ -75,6 +76,68 @@ Norda Biznes Hub is a **Flask-powered web platform** built with PostgreSQL, feat - **User Authentication** - Secure login with email confirmation and role-based access - **RESTful API** - JSON endpoints for programmatic access to company data +## Technology Stack + +### Backend +- **Python** 3.9+ - Core programming language +- **Flask** 3.0.0 - Web application framework +- **SQLAlchemy** 2.0.23 - ORM and database abstraction layer +- **PostgreSQL** - Primary relational database (production and development) +- **Gunicorn** - WSGI HTTP server for production deployment + +### Security & Authentication +- **Flask-Login** 0.6.3 - User session management and authentication +- **Flask-WTF** 1.2.1 - CSRF protection and form validation +- **Flask-Limiter** 3.5.0 - Rate limiting (200 req/day, 50 req/hour) + +### AI & Machine Learning +- **Google Gemini AI** (google-generativeai 0.3.2) + - Models: gemini-2.5-flash (default), gemini-2.5-flash-lite, gemini-2.5-pro + - Features: Multi-turn conversations, context-aware recommendations, AI-powered search + - Limits: Free tier (200 requests/day) + +### External API Integrations +1. **Google Gemini AI** - Conversational AI and company recommendations +2. **Google PageSpeed Insights** - SEO and performance analysis (25,000 req/day) +3. **Google Maps/Places** - Business verification and geocoding +4. **Microsoft Graph API** - Email service (OAuth2 with MSAL) +5. **KRS Open API** - Polish business registry data +6. **Brave Search API** - News monitoring and company mentions (2,000 req/month) + +### Frontend +- **Jinja2** - Server-side HTML template rendering (30+ templates) +- **CSS3** - Custom styling with Fluent Design System inspiration +- **Vanilla JavaScript** (ES6+) - Dynamic UI interactions, AJAX, form validation +- **No external frameworks** - Custom UI components (modals, toasts, cards, tables) + +### SEO & Web Analysis +- **BeautifulSoup4** 4.12.3 - HTML parsing and meta tag extraction +- **lxml** 5.1.0 - Fast XML/HTML processing with XPath support +- **python-whois** 0.9.4 - Domain information and WHOIS lookup + +### Infrastructure & Deployment +- **Nginx Proxy Manager** - Reverse proxy on R11-REVPROXY-01 (10.22.68.250) +- **Let's Encrypt** - SSL/TLS certificates with auto-renewal +- **Docker** - PostgreSQL container for local development +- **systemd** - Service management (nordabiznes.service) +- **Git** - Version control (GitHub + Gitea internal) + +### Database +- **PostgreSQL** - Primary database with advanced features: + - Full-text search (FTS) with tsvector + - Fuzzy matching with pg_trgm extension + - JSONB for flexible data storage + - 20+ tables (Company, User, Chat, News, Social Media, SEO, etc.) + - psycopg2-binary 2.9.9 adapter + +### Utilities +- **Flask-Mail** 0.9.1 - Email functionality +- **requests** 2.31.0 - HTTP client for external API calls +- **feedparser** 6.0.10 - RSS/Atom feed parsing +- **python-dotenv** 1.0.0 - Environment variable management + +--- + ## Features ### User-Facing Features @@ -1825,82 +1888,22 @@ While the platform is fully functional and in production, the following features **Note:** Features are prioritized based on member feedback and business value. See `CLAUDE.md` for detailed roadmap planning. -## Technology Stack +--- -### Backend -- **Python** 3.9+ - Core programming language -- **Flask** 3.0.0 - Web application framework -- **SQLAlchemy** 2.0.23 - ORM and database abstraction layer -- **PostgreSQL** - Primary relational database (production and development) -- **Gunicorn** - WSGI HTTP server for production deployment +## Contact -### Security & Authentication -- **Flask-Login** 0.6.3 - User session management and authentication -- **Flask-WTF** 1.2.1 - CSRF protection and form validation -- **Flask-Limiter** 3.5.0 - Rate limiting (200 req/day, 50 req/hour) +**Norda Biznes - Regionalna Izba Przedsiębiorców** -### AI & Machine Learning -- **Google Gemini AI** (google-generativeai 0.3.2) - - Models: gemini-2.5-flash (default), gemini-2.5-flash-lite, gemini-2.5-pro - - Features: Multi-turn conversations, context-aware recommendations, AI-powered search - - Limits: Free tier (200 requests/day) - -### External API Integrations -1. **Google Gemini AI** - Conversational AI and company recommendations -2. **Google PageSpeed Insights** - SEO and performance analysis (25,000 req/day) -3. **Google Maps/Places** - Business verification and geocoding -4. **Microsoft Graph API** - Email service (OAuth2 with MSAL) -5. **KRS Open API** - Polish business registry data -6. **Brave Search API** - News monitoring and company mentions (2,000 req/month) - -### Frontend -- **Jinja2** - Server-side HTML template rendering (30+ templates) -- **CSS3** - Custom styling with Fluent Design System inspiration -- **Vanilla JavaScript** (ES6+) - Dynamic UI interactions, AJAX, form validation -- **No external frameworks** - Custom UI components (modals, toasts, cards, tables) - -### SEO & Web Analysis -- **BeautifulSoup4** 4.12.3 - HTML parsing and meta tag extraction -- **lxml** 5.1.0 - Fast XML/HTML processing with XPath support -- **python-whois** 0.9.4 - Domain information and WHOIS lookup - -### Infrastructure & Deployment -- **Nginx Proxy Manager** - Reverse proxy on R11-REVPROXY-01 (10.22.68.250) -- **Let's Encrypt** - SSL/TLS certificates with auto-renewal -- **Docker** - PostgreSQL container for local development -- **systemd** - Service management (nordabiznes.service) -- **Git** - Version control (GitHub + Gitea internal) - -### Database -- **PostgreSQL** - Primary database with advanced features: - - Full-text search (FTS) with tsvector - - Fuzzy matching with pg_trgm extension - - JSONB for flexible data storage - - 20+ tables (Company, User, Chat, News, Social Media, SEO, etc.) - - psycopg2-binary 2.9.9 adapter - -### Utilities -- **Flask-Mail** 0.9.1 - Email functionality -- **requests** 2.31.0 - HTTP client for external API calls -- **feedparser** 6.0.10 - RSS/Atom feed parsing -- **python-dotenv** 1.0.0 - Environment variable management - -## Dane kontaktowe Norda Biznes - -- **Adres**: ul. 12 Marca 238/5, 84-200 Wejherowo +- **Address**: ul. 12 Marca 238/5, 84-200 Wejherowo - **Email**: biuro@norda-biznes.info -- **Telefon**: +48 729 716 400 -- **Web**: https://norda-biznes.info +- **Phone**: +48 729 716 400 +- **Website**: https://norda-biznes.info +- **Platform**: https://nordabiznes.pl -## Rozwój +--- -Projekt jest gotowy do rozbudowy. Kolejne fazy mogą obejmować: -1. Backend (Node.js, Python, PHP) -2. Baza danych (PostgreSQL, MongoDB) -3. Autoryzacja i uwierzytelnianie -4. API dla integracji z innymi systemami -5. Aplikacja mobilna +## License -## Licencja +Project created for Norda Biznes - Regional Chamber of Entrepreneurs -Projekt stworzony dla Norda Biznes - Regionalna Izba Przedsiębiorców +© 2025 Norda Biznes. All rights reserved.