https://github.com/tonykipkemboi/room-decorator-ai
🏠 Transform your room with AI-powered interior design using FLUX API. Clean, minimal UI with Jony Ive-inspired design.
https://github.com/tonykipkemboi/room-decorator-ai
Last synced: 3 months ago
JSON representation
🏠 Transform your room with AI-powered interior design using FLUX API. Clean, minimal UI with Jony Ive-inspired design.
- Host: GitHub
- URL: https://github.com/tonykipkemboi/room-decorator-ai
- Owner: tonykipkemboi
- License: mit
- Created: 2025-07-11T16:38:10.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-07-11T16:40:47.000Z (4 months ago)
- Last Synced: 2025-07-13T16:59:30.455Z (4 months ago)
- Language: Python
- Size: 384 KB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🏠 Room Decorator AI
**Transform your room with AI-powered interior design using the FLUX API**
[](https://github.com/tonykipkemboi/room-decorator-ai)
[](https://www.python.org/downloads/)
[](https://docs.bfl.ai/)
[](https://opensource.org/licenses/MIT)
*Upload a room photo, choose a style, and watch AI transform your space!*
---
## ✨ Features
- 🖼️ **Smart Image Upload** - Drag & drop room photos (PNG, JPG, JPEG up to 20MB)
- 🎨 **8 Preset Styles** - From Modern Minimalist to Bohemian, or create custom prompts
- ⚡ **Real-time Processing** - Watch your room transform in real-time
- 📱 **Responsive Design** - Works beautifully on desktop and mobile
- 📥 **Instant Download** - Get your decorated room image immediately
- ⚙️ **Flexible Aspect Ratios** - Choose from multiple output formats
---
## 🚀 Quick Start
### 1. Installation
```bash
# Clone the repository
git clone https://github.com/tonykipkemboi/room-decorator-ai.git
cd room-decorator-ai
# Install dependencies
pip install -r requirements.txt
```
### 2. Setup API Key
**For Local Development:**
```toml
# .streamlit/secrets.toml (optional)
BFL_API_KEY = "your_flux_api_key_here"
```
**For Public Deployment:**
- The app will prompt users to enter their own API key
- No setup required - users provide their own keys
> 💡 Get your API key from [Black Forest Labs](https://docs.bfl.ai/)
### 3. Run the App
**Clean, Minimal UI (Recommended):**
```bash
streamlit run streamlit_app_clean.py
```
**Feature-Rich UI:**
```bash
streamlit run streamlit_app.py
```
Open your browser to `http://localhost:8501` and start decorating! 🎉
---
## 🎨 Decoration Styles
🏢 Modern Minimalist
Sleek furniture with clean lines
🛋️ Cozy Living
Warm lighting and comfort
👑 Victorian Elegant
Ornate details and rich fabrics
💼 Modern Office
Professional workspace setup
🌈 Bohemian
Colorful and artistic vibes
🌲 Scandinavian
Light wood and minimalism
⚙️ Industrial
Exposed elements and metal
🏖️ Mediterranean
Warm colors and rustic charm
---
## 🔧 How It Works
1. **📤 Upload** your room photo
2. **🎯 Choose** a decoration style or write custom prompts
3. **⚡ Process** with FLUX.1 Kontext [pro] AI model
4. **📱 Preview** your transformed space
5. **💾 Download** the decorated image
---
## 🎨 Design Philosophy
This app comes in two versions:
### **Clean UI** (`streamlit_app_clean.py`) - *Recommended*
- **Jony Ive-inspired minimalism** - Only essential elements
- **Step-by-step flow** - Upload → Style → Generate
- **Zero cognitive overload** - One task at a time
- **Elegant simplicity** - Clean typography and subtle animations
- **Centered layout** - Focused, distraction-free design
### **Feature-Rich UI** (`streamlit_app.py`)
- **Advanced options** - Multiple controls and settings
- **Power user features** - Style intensity, quality options
- **Comprehensive feedback** - Detailed metrics and info
- **Sidebar controls** - All options accessible
---
## 📁 Project Structure
```
room-decorator-ai/
├── 🎯 streamlit_app_clean.py # Clean, minimal UI (recommended)
├── 🎛️ streamlit_app.py # Feature-rich UI with advanced options
├── 🔧 room_decorator.py # FLUX API wrapper class
├── 🧪 test_room_decorator.py # Comprehensive test suite
├── 📋 requirements.txt # Python dependencies
├── ⚙️ .streamlit/
│ ├── config.toml # Clean theme configuration
│ └── secrets.toml # API keys (gitignored)
├── 🖼️ assets/
│ └── image.png # App screenshot
├── 📚 docs.md # Comprehensive documentation
├── 🚫 .gitignore # Git ignore rules
└── 📖 README.md # This file
```
---
## ⚙️ Technical Specifications
| Feature | Specification |
|---------|---------------|
| **AI Model** | FLUX.1 Kontext [pro] |
| **Max File Size** | 20MB |
| **Supported Formats** | PNG, JPG, JPEG |
| **Processing Time** | 30-60 seconds |
| **Aspect Ratios** | 16:9, 4:3, 1:1, 3:4, 9:16 |
| **Concurrent Requests** | Up to 24 |
| **Image Expiration** | 10 minutes |
---
## 🎯 Usage Tips
### 📸 **Best Photo Practices**
- Use well-lit, clear room photos
- Ensure the room is the main focus
- Avoid cluttered or dark images
- Include architectural features for context
### ✍️ **Prompt Writing**
- Be specific about furniture and colors
- Mention lighting preferences
- Include style keywords (modern, vintage, etc.)
- Describe the room's intended use
### 🎨 **Style Combinations**
- Mix styles: "Scandinavian with industrial accents"
- Specify colors: "Add warm earth tones"
- Include textures: "Incorporate natural wood and metal"
---
## 🤝 Contributing
We welcome contributions! Here's how you can help:
1. 🍴 Fork the repository
2. 🌿 Create a feature branch (`git checkout -b feature/amazing-feature`)
3. 💾 Commit your changes (`git commit -m 'Add amazing feature'`)
4. 📤 Push to the branch (`git push origin feature/amazing-feature`)
5. 🔄 Open a Pull Request
---
## 📝 License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
## 🙏 Acknowledgments
- **[Black Forest Labs](https://blackforestlabs.ai/)** for the powerful FLUX API
- **[Streamlit](https://streamlit.io/)** for the amazing web framework
- **Community contributors** for feedback and improvements
---
**Made with ❤️ and AI**
[⭐ Star this repo](https://github.com/tonykipkemboi/room-decorator-ai/stargazers) • [🐛 Report Bug](https://github.com/tonykipkemboi/room-decorator-ai/issues) • [💡 Request Feature](https://github.com/tonykipkemboi/room-decorator-ai/issues)