An intelligent communication platform designed for remote teams, featuring AI-powered messaging capabilities including smart summarization, clarity assistance, action item extraction, and tone analysis.
MessengerAI enables remote teams to communicate with the clarity of synchronous meetings while maintaining the flexibility of asynchronous work. Built with Swift, SwiftUI, Firebase, and OpenAI.
Target Users: Remote software engineers, product designers, and product managers
- Frontend: Swift + SwiftUI (iOS 16+)
- Backend: Firebase (Auth, Firestore, Cloud Functions, Storage)
- AI Integration: OpenAI API (GPT-4) via Cloud Functions
- Pattern: MVVM (Model-View-ViewModel)
- State Management: Combine Framework
MessageAI/
βββ MessageAI/
β βββ App/ # App entry point and configuration
β βββ Models/ # Data models (User, Message, Conversation, etc.)
β βββ Views/ # SwiftUI views
β β βββ Authentication/
β β βββ Conversations/
β β βββ Chat/
β β βββ AI/
β β βββ Components/
β βββ ViewModels/ # MVVM view models
β βββ Services/ # Business logic services
β βββ Repositories/ # Data access layer
β βββ Utilities/ # Helper functions and extensions
β βββ Resources/ # Assets, plists, etc.
β
βββ MessageAITests/ # Unit and integration tests
βββ MessageAIUITests/ # UI tests
βββ CloudFunctions/ # Firebase Cloud Functions (Node.js/TypeScript)
βββ Package.swift # Swift Package Manager dependencies
- β Email/password authentication
- β Real-time 1:1 messaging
- β Message delivery and read receipts
- β Typing indicators
- β Offline support with message queue
- β Message history with pagination
- β Search functionality
- β Online/offline status
- π€ Smart Summarization: Auto-summarize long conversations
- π‘ Clarity Assistant: Pre-send suggestions to improve message clarity
- β Action Item Extraction: Automatically identify to-dos and commitments
- π― Tone Analysis: Detect and suggest improvements for message tone
- Xcode 15.0+ with iOS 16+ SDK
- Swift 5.9+
- Node.js 18+ (for Cloud Functions)
- Firebase CLI:
npm install -g firebase-tools - CocoaPods or Swift Package Manager
- Sweetpad (optional): For CLI automation
One-command setup:
./scripts/setup.shThis will automatically:
- Install Homebrew (if needed)
- Install XcodeGen, SwiftLint, Firebase CLI
- Install Node.js dependencies
- Generate Xcode project
- Run SwiftLint check
-
Clone the repository
git clone https://github.com/yourusername/messageai.git cd messageai -
Install development tools
brew install xcodegen swiftlint npm install -g firebase-tools
-
Install project dependencies
npm install npm run xcode:generate
-
Firebase Setup
# Login to Firebase firebase login # Select your Firebase project firebase use --add # Deploy backend npm run functions:deploy firebase deploy --only firestore:rules
-
Download Firebase Configuration
- Go to Firebase Console β Project Settings
- Download
GoogleService-Info.plist - Place it in
MessageAI/MessageAI/Resources/
-
Open in Xcode or Cursor
open MessageAI.xcodeproj # Or use Sweetpad in Cursor: # Cmd + Shift + B to build
Option 1: Xcode
- Select your target device/simulator
- Press
Cmd + Rto build and run
Option 2: Cursor with Sweetpad
Cmd + Shift + Bto build- Or use npm scripts:
npm run build # Build app
npm run test # Run tests
npm run lint # Check code quality
npm run lint:fix # Auto-fix lint issuesOption 3: Helper Scripts
./scripts/run-tests.sh # Run tests with coverage
./scripts/check-quality.sh # Run code quality checks
./scripts/clean.sh # Clean build artifactsQuick way:
./scripts/run-tests.shWith options:
./scripts/run-tests.sh --device "iPhone 15" --os "17.2"
./scripts/run-tests.sh --no-coverage # Skip coverage
./scripts/run-tests.sh --verbose # Show detailed outputManual:
# In Xcode: Cmd + U
# Or via command line:
npm run testCheck everything:
./scripts/check-quality.shThis checks:
- SwiftLint violations (strict mode)
- Large files (>1000 lines)
- TODO/FIXME comments
- Print statements
- Force unwrapping
- Test coverage ratio
All PRs automatically run:
- β SwiftLint (strict mode)
- β Unit tests with coverage
- β Build verification
- β PR format checks
See .github/workflows/ for GitHub Actions configuration.
main- Production-ready codedevelop- Integration branchfeature/*- New featuresbugfix/*- Bug fixeshotfix/*- Urgent production fixes
type(scope): description
Types: feat, fix, docs, style, refactor, test, chore
Examples:
- feat(auth): add login functionality
- fix(messaging): resolve offline sync issue
- docs(readme): update setup instructions
- Create feature branch from
develop - Implement feature with tests
- Run SwiftLint:
swiftlint - Ensure all tests pass
- Create PR with description and screenshots
- Request code review
- Merge after approval
- Firebase security rules enforce data access control
- OpenAI API keys stored securely in Firebase Functions config
- User authentication required for all operations
- No sensitive data in client code
- Firebase Analytics: Track user behavior and feature usage
- Firebase Crashlytics: Monitor app stability
- Firebase Performance Monitoring: Track app performance
- Cloud Functions Logs: Monitor backend operations
Build Errors:
- Clean build folder:
Cmd + Shift + K - Reset package dependencies:
File β Packages β Reset Package Caches
Firebase Connection Issues:
- Verify
GoogleService-Info.plistis correctly placed - Check Firebase project configuration in console
Cloud Functions Not Working:
- Verify functions are deployed:
firebase functions:list - Check function logs:
firebase functions:log
- Product Requirements Document - Detailed feature specifications
- Task List - Development roadmap and PR breakdown
- Architecture Guide - System design and patterns (coming soon)
- User Guide - End-user documentation (coming soon)
This is currently a private project for the Gauntlet AI team. For questions or suggestions, please contact the project maintainers.
Copyright Β© 2025 Gauntlet AI. All rights reserved.
- Firebase for backend infrastructure
- OpenAI for AI capabilities
- SwiftUI community for resources and inspiration
Version: 1.0.0
Last Updated: October 23, 2025
Maintained by: Gauntlet AI Team