ai-flow-dev 1.0.1

package/templates/mobile/README.template.md

@@ -0,0 +1,195 @@
+# {{PROJECT_NAME}}
+
+> {{PROJECT_DESCRIPTION}}
+
+---
+
+## 🚀 Quick Start
+
+### Prerequisites
+
+**For iOS Development:**
+- macOS (required for iOS development)
+- Xcode {{XCODE_VERSION}} or higher
+- CocoaPods (if using React Native)
+- Apple Developer Account ($99/year)
+
+**For Android Development:**
+- Android Studio {{ANDROID_STUDIO_VERSION}} or higher
+- JDK {{JDK_VERSION}}
+- Android SDK
+
+**For Cross-Platform:**
+- Node.js {{NODE_VERSION}} or higher
+- {{PACKAGE_MANAGER}} (npm/yarn/pnpm)
+- React Native CLI or Flutter SDK
+
+### Installation
+
+```bash
+# Clone the repository
+git clone <repository-url>
+cd {{PROJECT_NAME}}
+
+# Install dependencies
+{{PACKAGE_MANAGER}} install
+
+# iOS: Install pods (if React Native)
+cd ios && pod install && cd ..
+
+# Start development server
+{{PACKAGE_MANAGER}} run start
+
+# Run on iOS
+{{PACKAGE_MANAGER}} run ios
+
+# Run on Android
+{{PACKAGE_MANAGER}} run android
+```
+
+### Environment Setup
+
+Copy `.env.example` to `.env` and configure:
+
+```bash
+cp .env.example .env
+```
+
+See `specs/configuration.md` for all environment variables.
+
+---
+
+## 📁 Project Structure
+
+```
+{{FOLDER_STRUCTURE}}
+```
+
+---
+
+## 🛠️ Development
+
+### Available Scripts
+
+- `{{PACKAGE_MANAGER}} run start` - Start Metro bundler
+- `{{PACKAGE_MANAGER}} run ios` - Run on iOS simulator
+- `{{PACKAGE_MANAGER}} run android` - Run on Android emulator
+- `{{PACKAGE_MANAGER}} run test` - Run tests
+- `{{PACKAGE_MANAGER}} run lint` - Run linter
+- `{{PACKAGE_MANAGER}} run format` - Format code
+
+### Tech Stack
+
+- **Platform:** {{PLATFORMS}}
+- **Framework:** {{FRAMEWORK}} {{FRAMEWORK_VERSION}}
+- **Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
+- **Navigation:** {{NAVIGATION_LIBRARY}}
+- **State Management:** {{STATE_MANAGEMENT}}
+- **Storage:** {{STORAGE_SOLUTION}}
+- **Testing:** {{UNIT_TEST_FRAMEWORK}}, {{E2E_FRAMEWORK}}
+
+See `ai-instructions.md` for complete tech stack.
+
+---
+
+## 📚 Documentation
+
+**For AI Assistants:**
+- `AGENT.md` - Start here for AI context
+- `ai-instructions.md` - Tech stack and rules
+
+**For Developers:**
+- `docs/architecture.md` - System architecture
+- `docs/navigation.md` - Navigation patterns
+- `docs/state-management.md` - State patterns
+- `docs/offline-strategy.md` - Offline and sync strategy
+- `docs/permissions.md` - Permissions handling
+- `docs/native-features.md` - Native features integration
+- `docs/testing.md` - Testing strategy
+- `docs/app-store.md` - App Store configuration
+- `specs/build-configuration.md` - Build configuration
+- `specs/deployment.md` - Deployment procedures
+
+---
+
+## 🧪 Testing
+
+```bash
+# Run unit tests
+{{PACKAGE_MANAGER}} run test
+
+# Run with coverage
+{{PACKAGE_MANAGER}} run test:coverage
+
+# Run E2E tests
+{{PACKAGE_MANAGER}} run test:e2e
+
+# Run on physical device
+{{PACKAGE_MANAGER}} run ios --device
+{{PACKAGE_MANAGER}} run android --device
+```
+
+---
+
+## 📱 Building for Production
+
+### iOS
+
+```bash
+# Build for App Store
+{{PACKAGE_MANAGER}} run build:ios:release
+
+# Archive and upload via Xcode
+# Or use Fastlane: fastlane ios release
+```
+
+### Android
+
+```bash
+# Build APK
+{{PACKAGE_MANAGER}} run build:android:apk
+
+# Build AAB (for Play Store)
+{{PACKAGE_MANAGER}} run build:android:aab
+
+# Or use Fastlane: fastlane android release
+```
+
+See `specs/deployment.md` for detailed deployment instructions.
+
+---
+
+## 🚀 Deployment
+
+### App Store (iOS)
+
+1. Build and archive in Xcode
+2. Upload to App Store Connect
+3. Submit for review
+
+See `docs/app-store.md` for detailed instructions.
+
+### Play Store (Android)
+
+1. Build AAB file
+2. Upload to Google Play Console
+3. Submit for review
+
+See `docs/app-store.md` for detailed instructions.
+
+---
+
+## 📄 License
+
+{{LICENSE}}
+
+---
+
+## 🤝 Contributing
+
+See `docs/contributing.md` for contribution guidelines.
+
+---
+
+**Last Updated:** {{LAST_UPDATED}}
+

package/templates/mobile/ai-instructions.template.md

@@ -0,0 +1,221 @@
+# AI Instructions - Mobile
+
+> **CRITICAL:** Every AI assistant MUST read and follow this document before any work.
+
+---
+
+## 🎯 Project Overview
+
+**Name:** {{PROJECT_NAME}}
+
+**Description:** {{PROJECT_DESCRIPTION}}
+
+**Purpose:** {{PROBLEM_STATEMENT}}
+
+**Target Users:** {{TARGET_USERS}}
+
+---
+
+## 🏗️ Tech Stack
+
+### Mobile Platform
+
+- **Platforms:** {{PLATFORMS}}
+- **Framework:** {{FRAMEWORK}} {{FRAMEWORK_VERSION}}
+- **Language:** {{LANGUAGE}} {{LANGUAGE_VERSION}}
+- **Minimum iOS:** {{MIN_IOS_VERSION}}
+- **Minimum Android:** {{MIN_ANDROID_VERSION}} (API {{MIN_ANDROID_API}})
+
+### UI/UX Framework
+
+- **UI Framework:** {{UI_FRAMEWORK}}
+- **Dark Mode:** {{DARK_MODE_STRATEGY}}
+- **Internationalization:** {{I18N_STRATEGY}} ({{I18N_LIBRARY}})
+- **Image Management:** {{IMAGE_MANAGEMENT_STRATEGY}} ({{IMAGE_OPTIMIZATION_LIBRARY}})
+
+### Navigation
+
+- **Navigation Library:** {{NAVIGATION_LIBRARY}}
+- **Navigation Pattern:** {{NAVIGATION_PATTERN}}
+- **Deep Linking:** {{DEEP_LINKING_STRATEGY}}
+
+### State Management
+
+- **State Solution:** {{STATE_MANAGEMENT}}
+- **HTTP Client:** {{HTTP_CLIENT_LIBRARY}}
+- **Storage:** {{STORAGE_SOLUTION}}
+- **Offline Strategy:** {{OFFLINE_STRATEGY}}
+- **Network Error Handling:** {{NETWORK_ERROR_HANDLING}}
+
+### Native Features
+
+- **Permissions:** {{PERMISSIONS_LIST}}
+- **Native Modules:** {{NATIVE_MODULES_LIST}}
+- **Third-Party SDKs:** {{THIRD_PARTY_SDKS}}
+
+### Testing
+
+- **Unit Testing:** {{UNIT_TEST_FRAMEWORK}}
+- **Component Testing:** {{COMPONENT_TEST_LIBRARY}}
+- **E2E Testing:** {{E2E_FRAMEWORK}}
+- **Coverage Target:** {{TEST_COVERAGE_TARGET}}
+
+### Build & Deployment
+
+- **CI/CD:** {{CICD_PLATFORM}}
+- **Code Signing:** {{CODE_SIGNING_STRATEGY}}
+- **Versioning:** {{VERSIONING_STRATEGY}}
+- **Analytics:** {{ANALYTICS_TOOL}}
+- **Crash Reporting:** {{CRASH_REPORTING_TOOL}}
+
+---
+
+## 🏛️ Architecture
+
+**Architecture Pattern:** {{ARCHITECTURE_PATTERN}}
+
+{{ARCHITECTURE_DESCRIPTION}}
+
+**File Organization:** {{FILE_ORGANIZATION}}
+
+**Folder Structure:**
+```
+{{FOLDER_STRUCTURE}}
+```
+
+---
+
+## ❌ NEVER Rules
+
+**YOU MUST NEVER:**
+
+### Performance
+
+- ❌ Render large lists without virtualization - Use FlatList (React Native), ListView.builder (Flutter)
+- ❌ Forget to dispose resources - Remove listeners, cancel timers, close streams
+- ❌ Use heavy operations on main thread - Use background threads for heavy work
+- ❌ Load all data at once - Implement pagination and lazy loading
+
+### Memory
+
+- ❌ Create memory leaks - Always dispose listeners, subscriptions, timers
+- ❌ Hold references to large objects - Use weak references when appropriate
+- ❌ Forget to release native resources - Close cameras, file handles, etc.
+
+### Network
+
+- ❌ Make requests without error handling - Always handle network errors gracefully
+- ❌ Ignore offline scenarios - Handle offline state, show cached data
+- ❌ Forget to cancel requests - Cancel requests when component unmounts
+
+### Permissions
+
+- ❌ Request permissions without explanation - Explain why permission is needed
+- ❌ Request all permissions at once - Request just-in-time
+- ❌ Ignore permission denial - Handle gracefully, show alternatives
+
+### Platform Differences
+
+- ❌ Assume iOS and Android are identical - Handle platform-specific code
+- ❌ Use platform-specific APIs without checks - Check platform before using
+- ❌ Ignore platform guidelines - Follow iOS Human Interface Guidelines and Material Design
+
+---
+
+## ✅ ALWAYS Rules
+
+**YOU MUST ALWAYS:**
+
+### Code Quality
+
+- ✅ Use TypeScript/Dart strict mode
+- ✅ Follow naming conventions: {{FILE_NAMING_CONVENTION}}
+- ✅ Write unit tests for business logic
+- ✅ Handle errors gracefully
+- ✅ Use proper error boundaries (React Native) or error handlers (Flutter)
+
+### Performance
+
+- ✅ Optimize images - Use appropriate formats and sizes
+- ✅ Implement lazy loading for screens and components
+- ✅ Use memoization for expensive computations
+- ✅ Monitor app performance - Track FPS, memory usage, battery
+
+### User Experience
+
+- ✅ Show loading states - Use skeleton screens or spinners
+- ✅ Handle offline gracefully - Show cached data, queue updates
+- ✅ Request permissions just-in-time - Explain why needed
+- ✅ Follow platform design guidelines - iOS HIG and Material Design
+
+### Security
+
+- ✅ Store sensitive data securely - Use secure storage (Keychain/Keystore)
+- ✅ Validate all user input
+- ✅ Use HTTPS for all network requests
+- ✅ Implement certificate pinning for production
+
+### Testing
+
+- ✅ Test on physical devices - Not just simulators/emulators
+- ✅ Test on multiple screen sizes
+- ✅ Test offline scenarios
+- ✅ Test permission flows
+
+---
+
+## 📱 Mobile-Specific Guidelines
+
+### iOS
+
+- ✅ Follow iOS Human Interface Guidelines
+- ✅ Use native iOS navigation patterns
+- ✅ Support Dark Mode
+- ✅ Handle Safe Area insets
+- ✅ Use SF Symbols for icons
+
+### Android
+
+- ✅ Follow Material Design guidelines
+- ✅ Use Material Components
+- ✅ Support different screen densities
+- ✅ Handle system bars (status bar, navigation bar)
+- ✅ Use Material Icons
+
+### Cross-Platform
+
+- ✅ Use platform-specific code when needed
+- ✅ Test on both platforms
+- ✅ Handle platform differences gracefully
+- ✅ Use platform detection utilities
+
+---
+
+## 🔄 Development Workflow
+
+1. **Read this file first** - Understand tech stack and rules
+2. **Check existing code** - Follow established patterns
+3. **Write tests** - Unit tests for logic, integration tests for flows
+4. **Test on devices** - Not just simulators
+5. **Handle errors** - Graceful error handling
+6. **Optimize performance** - Monitor and optimize
+
+---
+
+## 📚 Key Documentation
+
+- `AGENT.md` - Universal AI context
+- `docs/architecture.md` - System architecture
+- `docs/navigation.md` - Navigation patterns
+- `docs/state-management.md` - State management
+- `docs/offline-strategy.md` - Offline handling
+- `docs/permissions.md` - Permissions handling
+- `docs/testing.md` - Testing strategy
+- `docs/app-store.md` - App Store deployment
+
+---
+
+**Last Updated:** {{LAST_UPDATED}}
+
+**Version:** {{PROJECT_VERSION}}
+

package/templates/mobile/docs/app-store.template.md

@@ -0,0 +1,163 @@
+# App Store Configuration
+
+> App Store and Play Store deployment guide for {{PROJECT_NAME}}
+
+---
+
+## 📱 App Stores
+
+**Target Stores:** {{TARGET_STORES}}
+
+- **iOS:** {{IOS_STORE_ENABLED}}
+- **Android:** {{ANDROID_STORE_ENABLED}}
+
+---
+
+## 🍎 Apple App Store
+
+### App Store Connect Setup
+
+**Bundle ID:** {{IOS_BUNDLE_ID}}
+
+**App Name:** {{IOS_APP_NAME}}
+
+**Version:** {{IOS_VERSION}}
+
+**Build Number:** {{IOS_BUILD_NUMBER}}
+
+### Required Metadata
+
+- **App Name:** {{IOS_APP_NAME}} (30 characters max)
+- **Subtitle:** {{IOS_SUBTITLE}} (30 characters max)
+- **Description:** {{IOS_DESCRIPTION}} (4000 characters max)
+- **Keywords:** {{IOS_KEYWORDS}}
+- **Privacy Policy URL:** {{PRIVACY_POLICY_URL}}
+
+### Screenshots
+
+**Required Sizes:**
+{{IOS_SCREENSHOT_SIZES}}
+
+### App Icon
+
+**Size:** 1024x1024 pixels
+
+### Review Information
+
+**Demo Account:** {{IOS_DEMO_ACCOUNT}}
+
+**Review Notes:** {{IOS_REVIEW_NOTES}}
+
+---
+
+## 🤖 Google Play Store
+
+### Play Console Setup
+
+**Package Name:** {{ANDROID_PACKAGE_NAME}}
+
+**App Name:** {{ANDROID_APP_NAME}}
+
+**Version Code:** {{ANDROID_VERSION_CODE}}
+
+**Version Name:** {{ANDROID_VERSION_NAME}}
+
+### Required Metadata
+
+- **App Name:** {{ANDROID_APP_NAME}} (50 characters max)
+- **Short Description:** {{ANDROID_SHORT_DESCRIPTION}} (80 characters max)
+- **Full Description:** {{ANDROID_FULL_DESCRIPTION}} (4000 characters max)
+- **Privacy Policy URL:** {{PRIVACY_POLICY_URL}}
+
+### Screenshots
+
+**Required Sizes:**
+{{ANDROID_SCREENSHOT_SIZES}}
+
+### App Icon
+
+**Size:** 512x512 pixels
+
+### Feature Graphic
+
+**Size:** 1024x500 pixels
+
+---
+
+## 🚀 Deployment Process
+
+### iOS Deployment
+
+{{IOS_DEPLOYMENT_PROCESS}}
+
+### Android Deployment
+
+{{ANDROID_DEPLOYMENT_PROCESS}}
+
+---
+
+## 🔄 Release Strategy
+
+**Release Strategy:** {{RELEASE_STRATEGY}}
+
+{{RELEASE_STRATEGY_DESCRIPTION}}
+
+---
+
+## 📊 Beta Testing
+
+**Beta Testing Strategy:** {{BETA_TESTING_STRATEGY}}
+
+**iOS:** {{IOS_BETA_TESTING}}
+
+**Android:** {{ANDROID_BETA_TESTING}}
+
+---
+
+## 🔐 Code Signing
+
+**Code Signing Strategy:** {{CODE_SIGNING_STRATEGY}}
+
+{{CODE_SIGNING_DESCRIPTION}}
+
+---
+
+## 📈 Monitoring
+
+**Analytics:** {{ANALYTICS_TOOL}}
+
+**Crash Reporting:** {{CRASH_REPORTING_TOOL}}
+
+**App Store Analytics:** {{STORE_ANALYTICS_ENABLED}}
+
+---
+
+## ✅ Checklist
+
+### Pre-Release
+
+- [ ] All features tested
+- [ ] Screenshots prepared
+- [ ] App metadata complete
+- [ ] Privacy policy published
+- [ ] Demo account ready (if needed)
+- [ ] Beta testing completed
+
+### Release
+
+- [ ] Build uploaded to stores
+- [ ] Metadata reviewed
+- [ ] Screenshots verified
+- [ ] Submitted for review
+
+### Post-Release
+
+- [ ] Monitor crash reports
+- [ ] Monitor user reviews
+- [ ] Monitor analytics
+- [ ] Plan updates
+
+---
+
+**Last Updated:** {{LAST_UPDATED}}
+

package/templates/mobile/docs/architecture.template.md

@@ -0,0 +1,100 @@
+# Architecture Guide
+
+> System architecture for {{PROJECT_NAME}}
+
+---
+
+## 🏗️ Architecture Overview
+
+**Architecture Pattern:** {{ARCHITECTURE_PATTERN}}
+
+**Framework:** {{FRAMEWORK}} {{FRAMEWORK_VERSION}}
+
+**Platforms:** {{PLATFORMS}}
+
+---
+
+## 📐 Architecture Layers
+
+{{ARCHITECTURE_LAYERS_DESCRIPTION}}
+
+---
+
+## 📁 Folder Structure
+
+```
+{{FOLDER_STRUCTURE}}
+```
+
+---
+
+## 🔄 Data Flow
+
+{{DATA_FLOW_DESCRIPTION}}
+
+---
+
+## 🧩 Component Architecture
+
+**Component Pattern:** {{COMPONENT_PATTERN}}
+
+{{COMPONENT_ARCHITECTURE_DESCRIPTION}}
+
+---
+
+## 🔌 API Integration
+
+**API Style:** {{API_STYLE}}
+
+**API Client:** {{API_CLIENT}}
+
+{{API_INTEGRATION_DESCRIPTION}}
+
+---
+
+## 💾 State Management
+
+**State Solution:** {{STATE_MANAGEMENT}}
+
+**Storage:** {{STORAGE_SOLUTION}}
+
+{{STATE_MANAGEMENT_DESCRIPTION}}
+
+---
+
+## 🧭 Navigation
+
+**Navigation Library:** {{NAVIGATION_LIBRARY}}
+
+**Navigation Pattern:** {{NAVIGATION_PATTERN}}
+
+{{NAVIGATION_ARCHITECTURE_DESCRIPTION}}
+
+---
+
+## 🔐 Security
+
+{{SECURITY_DESCRIPTION}}
+
+---
+
+## 📱 Platform-Specific Code
+
+{{PLATFORM_SPECIFIC_CODE_DESCRIPTION}}
+
+---
+
+## 🧪 Testing Strategy
+
+{{TESTING_STRATEGY_DESCRIPTION}}
+
+---
+
+## 🚀 Performance Considerations
+
+{{PERFORMANCE_CONSIDERATIONS}}
+
+---
+
+**Last Updated:** {{LAST_UPDATED}}
+