Lyn Housing AI is a full-stack intelligent real estate platform that combines cutting-edge artificial intelligence with modern web technologies to revolutionize property search, analysis, and investment decision-making. Built for home buyers, real estate professionals, and investors who want data-driven insights and AI-powered property recommendations.
- 📍 Features
- 💻 Tech Stack
- 🏗️ Architecture
- 📂 Project Structure
- ⚙️ Getting Started
- 🛠️ API Endpoints
- 🔧 Development
- 🤝 Contributing
- 📜 License
- 🤖 AI-Powered Property Analysis with OpenAI integration for real estate market insights and price predictions
- 🏠 Comprehensive Property Search with city-based filtering, autocomplete suggestions, and advanced sorting
- 🔐 Secure Firebase Authentication with complete user registration, login, and session management
- 📊 Interactive Data Visualization including price history charts and property comparison tools
- 🗺️ Property Mapping & Location Intelligence with Leaflet maps and walkability scoring
- 📱 Responsive Design Excellence optimized for desktop, tablet, and mobile experiences
- ⚡ High-Performance Architecture using Django REST API with SQLite (dev) / PostgreSQL (prod)
- 🧠 Real-Time Form Validation with instant client-side feedback and error handling
- 🧭 Smart Navigation System with context-aware back buttons and page state preservation
- 📋 RESTful API Design with comprehensive documentation and modular endpoint structure
| Layer | Technology |
|---|---|
| Frontend | ReactJS (Vite), Font Awesome, Leaflet Maps |
| Backend | Django (REST Framework), OpenAI API |
| Authentication | Firebase Authentication |
| Database | SQLite (dev), PostgreSQL (prod) |
| AI/ML | OpenAI GPT for property analysis and market insights |
| Containerization | Docker with Docker Compose |
| Version Control | Git/GitHub |
| Deployment | Vercel (Frontend) Render (Backend) |
ReactJS Frontend (Vite)
│
├── Firebase Authentication (User Management)
├── Leaflet Maps (Interactive Property Maps)
│
▼
Django REST API Backend
│
├── OpenAI GPT Integration (AI Property Analysis)
├── Analysis Caching System
│
▼
SQLite (Development) / PostgreSQL (Production)
│
▼
External Services:
• Walk Score API (Walkability Data)
• Geocoding Services (Location Intelligence)
• Image Hosting (Property Media)
lyn-housing-ai-app/
├── backend/ # Django REST API
│ ├── listings/ # Property listings app
│ │ ├── models.py # Database models (Listing, PriceHistory, AnalysisCache)
│ │ ├── serializer.py # Data serialization for API responses
│ │ ├── views.py # API endpoints + OpenAI integration
│ │ ├── urls.py # URL routing for listings and AI analysis
│ │ ├── admin.py # Django admin configuration
│ │ ├── migrations/ # Database migration files
│ │ └── management/commands/ # Custom Django commands
│ ├── lynapp-django/ # Main Django project
│ │ ├── settings.py # Project settings + environment config
│ │ ├── urls.py # Root URL configuration
│ │ ├── wsgi.py # WSGI configuration
│ │ └── asgi.py # ASGI configuration
│ ├── requirements.txt # Python dependencies (Django, OpenAI, etc.)
│ ├── manage.py # Django management script
│ ├── db.sqlite3 # SQLite database (development)
│ ├── Dockerfile # Docker container configuration
│ └── compose.yaml # Docker Compose for backend
├── frontend/lynapp-react/ # React Frontend (Vite)
│ ├── public/ # Static assets (favicon, images, SEO files)
│ ├── src/
│ │ ├── components/ # Reusable React components
│ │ │ ├── buttons/ # Action buttons (AI Analysis, Schedule, etc.)
│ │ │ │ ├── AiAnalysisButton.jsx # AI-powered property analysis trigger
│ │ │ │ ├── FavoriteButton.jsx # Property favoriting functionality
│ │ │ │ ├── ScheduleButton.jsx # Viewing appointment scheduler
│ │ │ │ └── RoiCalculatorButton.jsx # ROI calculation tool
│ │ │ ├── utility/ # Utility components
│ │ │ │ ├── SimpleToast.jsx # Notification system
│ │ │ │ ├── ListingCard.jsx # Property listing display card
│ │ │ │ ├── PropertyMap.jsx # Interactive Leaflet maps
│ │ │ │ ├── PriceHistoryChart.jsx # Chart.js price visualization
│ │ │ │ ├── ImageGallery.jsx # Property image carousel
│ │ │ │ ├── ScoreBadge.jsx # Walkability/Transit scores
│ │ │ │ └── PropertySearchBox.jsx # City search with autocomplete
│ │ ├── contexts/ # React Context providers
│ │ │ └── AuthContext.jsx # Firebase authentication state
│ │ ├── hooks/ # Custom React hooks
│ │ │ └── useListings.js # Property data fetching logic
│ │ ├── pages/ # Page components
│ │ │ ├── auth/ # Authentication pages
│ │ │ │ ├── LoginPage.jsx # User login with Firebase
│ │ │ │ └── RegisterPage.jsx # User registration with validation
│ │ │ ├── guest/ # Public pages
│ │ │ │ ├── HomePage.jsx # Landing page with AI features
│ │ │ │ ├── AboutPage.jsx # Company/team information
│ │ │ │ ├── PropertiesPage.jsx # Property search and filtering
│ │ │ │ └── PropertyDetailPage.jsx # Detailed property view + AI analysis
│ │ │ └── user/ # Authenticated user pages
│ │ │ └── UserDashboardPage.jsx # User dashboard after login
│ │ ├── services/ # API and external service integrations
│ │ │ ├── api.js # Django REST API client
│ │ │ └── firebase.js # Firebase configuration
│ │ ├── tools/ # Utility functions
│ │ │ ├── InputValidation.js # Form validation helpers
│ │ │ └── ScrollToTop.jsx # Navigation utilities
│ │ ├── styles/ # Global styling
│ │ │ └── colors.css # Design system color variables
│ │ ├── App.jsx # Main application component + routing
│ │ ├── main.jsx # React entry point
│ │ └── index.css # Global CSS resets and base styles
│ ├── package.json # Node.js dependencies
│ ├── vite.config.js # Vite build configuration
│ ├── index.html # HTML template with SEO meta tags
│ ├── Dockerfile # Docker container for frontend
│ └── compose.yaml # Docker Compose for frontend
├── docs/ # Project documentation
│ ├── API.md # RESTful API endpoint documentation
│ ├── ARCHITECTURE.md # System architecture overview
│ ├── CONTRIBUTING.md # Contribution guidelines
│ ├── DEVELOPMENT.md # Development setup guide
│ ├── INSTALLATION.md # Installation instructions
│ └── PROJECT-STRUCTURE.md # Project organization details
├── docker-compose.yml # Multi-service Docker orchestration
├── start-lynapp-macos.sh # macOS startup script
├── start-lynapp-win.bat # Windows startup script
├── LICENSE # MIT License
└── README.md # Project overview and setup guide
- Python 3.8+ with pip package manager
- Node.js 16+ with npm package manager
- OpenAI API Key for AI property analysis features
- Firebase Project for authentication services
- Clone the repository
git clone https://github.com/ndmh99/lyn-housing-ai-app.git
cd lyn-housing-ai-app- Backend Setup (Django)
cd backend
python -m venv venv
source venv/bin/activate # On Windows: venv\Scripts\activate
pip install -r requirements.txt
# Create environment file
cp .env.example .env # Edit with your API keys
python manage.py migrate
python manage.py runserver- Frontend Setup (React)
cd frontend/lynapp-react
npm install
# Create environment file
cp .env.example .env # Edit with your Firebase config
npm run dev# macOS/Linux
./start-lynapp-macos.sh
# Windows
start-lynapp-win.bat- Frontend: http://localhost:5173
- Backend API: http://127.0.0.1:8000
- Admin Panel: http://127.0.0.1:8000/admin
Backend (.env):
SECRET_KEY=your_django_secret_key
DEBUG=True
OPENAI_API_KEY=your_openai_api_key
ALLOWED_HOSTS=localhost,127.0.0.1Frontend (.env):
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_project.firebaseapp.com
VITE_FIREBASE_PROJECT_ID=your_project_id| Method | Endpoint | Description |
|---|---|---|
GET |
/api/listings/ |
Get all property listings |
GET |
/api/listings/{id}/ |
Get specific property details |
GET |
/api/listings/search/?city={city} |
Search properties by city |
POST |
/api/listings/create/ |
Create new property listing |
PUT |
/api/listings/{id}/update/ |
Update existing property |
DELETE |
/api/listings/{id}/delete/ |
Delete property listing |
| Method | Endpoint | Description |
|---|---|---|
POST |
/api/listings/analyze-housing/ |
Generate AI property analysis using OpenAI |
- Caching System: AI analysis results are cached to improve performance
- Error Handling: Comprehensive error responses with details
- Authentication: Firebase token validation for protected endpoints
- Rate Limiting: Built-in protection against API abuse
📖 Full Documentation: API Reference Guide
main: Production-ready stable releasesdevelop: Active development branch (current)test: Integration testing environmentdeployment: Cloud deployment configurations
- Fork the repository and create feature branches from
develop - Follow the coding standards and run tests locally
- Submit pull requests targeting the
developbranch - All PRs require review before merging
# Start backend with hot reload
cd backend && python manage.py runserver
# Start frontend with hot reload
cd frontend/lynapp-react && npm run dev
# Run tests
cd backend && python manage.py test
cd frontend/lynapp-react && npm test# Start all services
docker-compose up --build
# Backend only
cd backend && docker-compose up
# Frontend only
cd frontend/lynapp-react && docker-compose up📖 Contributing: See CONTRIBUTING.md for detailed guidelines
We welcome contributions from developers of all experience levels! Here's how you can help:
- Fork the repository and clone your fork locally
- Create a feature branch from
develop:git checkout -b feature/your-feature-name - Make your changes following our coding standards
- Test thoroughly and ensure all tests pass
- Submit a Pull Request with a clear description of changes
- 🤖 AI Features: Enhance property analysis algorithms
- 🎨 UI/UX: Improve user interface and experience
- 📊 Data Visualization: Add new chart types and analytics
- 🔧 Performance: Optimize loading times and responsiveness
- 📱 Mobile: Enhance mobile user experience
- 🧪 Testing: Expand test coverage and automation
- Follow existing code style and conventions
- Write meaningful commit messages
- Include tests for new features
- Update documentation as needed
- Be respectful and collaborative in discussions
🤝 Questions? Open an issue or discussion thread
📋 Detailed Guidelines: CONTRIBUTING.md
lyn-housing-ai-app 🏡✨ 2025