ProjectForge AI 🛠️✨

ProjectForge AI is an offline-first native Android assistant powered by local design patterns and AI integration fallbacks. It enables software engineers to draft, compile, and showcase high-impact portfolio project cards and full markdown specifications for their GitHub profiles and portfolio reviews.

---

💡 The Problem

Many developers struggle to present their technical achievements clearly on GitHub or in portfolio interviews. They often fail to highlight key architectural choices, technical hurdles, and mitigation strategies, which prevents recruiters or technical leads from recognizing their engineering capabilities.

🔑 The Solution

ProjectForge AI guides developers through a structured project-building questionnaire, capturing technical depth and architectural nuances. Using modern on-device templating or remote Gemini API integration, it auto-generates professional GitHub READMEs, case studies, release notes, and social captions. Users can then export unified markdown project packs or share files via native Android FileProvider.

---

✨ Key Features

• Structured Portfolio Builder: Fill in project details, technical hurdles, resolved bugs, and specific portfolio takeaways.
• AI-Assisted Documentation: Instant generation of professional documentation:
  • GitHub README.md
  • Portfolio Case Studies
  • Structured Release Notes
  • App Store / Google Play Descriptions
  • Social Media Captioning
  • Demo Video Script Drafts
• High-Fidelity Offline Fallback: If no Gemini API Key is provided or there is no network connection, the application activates an advanced mock content generator loaded with rich contextual response templates.
• Unified Markdown Exports: Build and compile entire projects, including full generation history, into a unified Project Pack.
• Native FileProvider Integration: Share files securely through the Android Native Share Sheet using secure temporary URIs.
• Interactive Showcase & Search: Real-time search, filter chips, and interactive cards in a responsive interface.

---

🛠️ Tech Stack

• Language: Kotlin
• UI Framework: Jetpack Compose (Declarative UI)
• Design System: Material Design 3 (M3)
• Architecture: Model-View-ViewModel (MVVM)
• Local Persistence: Room Database (SQLite with Flow)
• Asynchronous Operations: Coroutines & StateFlow
• Network Client: Retrofit 2
• Image Loading: Coil
• File Sharing: Android FileProvider

---

🏗️ Architecture

The project follows clean architecture principles to ensure testability, readability, and offline reliability:

├── com.example
│   ├── MainActivity.kt               # Single-activity container and NavHost routing
│   ├── data
│   │   ├── local                     # Room Database, DAOs, and entities
│   │   ├── model                     # Core data entities (Project, Generated Content)
│   │   ├── remote                    # Network layer & Retrofit Client
│   │   ├── repository                # Repository pattern abstracts data operations
│   │   └── service                   # Business services (AI generator, Export service)
│   └── ui
│       ├── screens                   # Declarative Jetpack Compose screens
│       ├── theme                     # Visual theme, Color scheme, Typography
│       └── viewmodel                 # MVVM StateFlow management

Decoupled Service Fallbacks

The AI documentation engine implements an interface-based architecture (AiContentGenerator). This separates remote Gemini APIs (GeminiAiContentGenerator) from local high-fidelity templates (MockAiContentGenerator). When API keys are absent, the application gracefully routes requests to the local generator with zero interruption or crash risks.

---

📱 App Flow & Navigation

1. Home Dashboard: Browse all portfolio items. Filter using chips (All Projects, Recent, Showcase Ready). Tap Load Demo to instantaneously populate the database with a high-fidelity showcase of ProjectForge AI.
2. Add/Edit Project Screen: Fill in technical characteristics using a filled Material 3 questionnaire.
3. Project Details: Review general information, edit values, generate AI artifacts, or export/share the complete unified portfolio pack.
4. AI Generation Interface: Select documentation targets, trigger generation (using mock/live engines), copy markdown output, or share raw .md files.

---

🔒 Security Notes & API Keys

ProjectForge AI is designed with strict security guidelines:

• No Hardcoded Keys: Gemini API integrations resolve keys dynamically through BuildConfig.GEMINI_API_KEY.
• Zero Configuration Run: No local keys are required to explore all features. Mock generator fallbacks initiate immediately.
• Secure File Sharing: No raw storage paths are shared. All generated files are compiled into private application caches and exposed temporarily via an Android FileProvider with read-only URI permission grants.

---

📦 Version Information

• Current Version: 1.4.0 (Portfolio Release)
• Build Status: Compiling cleanly