mrbeniwal commited on
Commit
9a4e7bf
Β·
1 Parent(s): 110797e

Update README with Hugging Face Space metadata and formatting

Browse files
Files changed (1) hide show
  1. README.md +78 -56
README.md CHANGED
@@ -1,86 +1,108 @@
1
- # Multi Image - Image Generation Web App
 
 
 
 
 
 
 
 
2
 
3
- A Next.js web application for generating images using multiple AI providers (OpenAI, Google Generative AI, Qwen).
4
 
5
- ## Features
6
 
7
- - Multi-provider image generation support
8
- - Smart model selection based on availability
9
- - Real-time image generation with progress tracking
10
- - History management for generated images
11
- - Dark/Light theme support
12
- - API key management through settings panel
13
 
14
- ## Supported Providers
 
 
 
 
 
15
 
16
- - **OpenAI** - DALL-E 3
17
- - **Google Generative AI** - Imagen
18
- - **Qwen** - Qwen Image Generation
19
 
20
- ## Getting Started
 
 
 
 
21
 
22
- ### Prerequisites
23
 
24
- - Node.js 18+
25
- - API keys for at least one of the supported providers
 
26
 
27
- ### Installation
28
 
29
- 1. Clone the repository
30
- 2. Install dependencies:
31
- ```bash
32
- npm install
33
- ```
34
-
35
- 3. Set up environment variables:
36
- ```bash
37
- cp .env.example .env.local
38
- ```
39
-
40
- 4. Add your API keys to the settings panel in the app
41
 
42
- ### Development
43
 
44
  ```bash
45
- npm run dev
46
- ```
47
-
48
- The app will be available at `http://localhost:9002`
49
 
50
- ### Build
 
 
51
 
52
- ```bash
53
  npm run build
 
 
54
  npm start
55
  ```
56
 
57
- ## Environment Variables
 
 
 
 
 
 
58
 
59
- The application uses API keys from the settings panel. No environment variables are required for deployment.
60
 
61
- ## Deployment on Hugging Face Spaces
 
 
 
62
 
63
- This application is configured to run on Hugging Face Spaces using Docker.
 
 
64
 
65
- 1. Create a new Space on Hugging Face (Docker runtime)
66
- 2. Clone this repository into the space
67
- 3. Push to the space:
68
  ```bash
69
- git push origin main
 
 
 
 
70
  ```
71
 
72
- The application will automatically build and deploy.
 
 
 
 
 
 
 
 
 
73
 
74
- ## Technologies Used
75
 
76
- - Next.js 15
77
- - React 19
78
- - TypeScript
79
- - Tailwind CSS
80
- - Genkit AI
81
- - Firebase (for features)
82
- - Radix UI components
83
 
84
- ## License
85
 
86
- MIT
 
1
+ ---
2
+ title: Multi Image Generator
3
+ emoji: 🎨
4
+ colorFrom: purple
5
+ colorTo: blue
6
+ sdk: docker
7
+ app_file: app.py
8
+ pinned: false
9
+ ---
10
 
11
+ # Multi Image Generator
12
 
13
+ A powerful Next.js web application for generating images using multiple AI providers. Generate stunning images with OpenAI DALL-E 3, Google Generative AI, or Qwen - all from one unified interface.
14
 
15
+ ## ✨ Features
 
 
 
 
 
16
 
17
+ - πŸ€– **Multi-Provider Support** - Use OpenAI, Google Generative AI, or Qwen
18
+ - 🧠 **Smart Model Selection** - Automatically route to the best available provider
19
+ - ⚑ **Real-time Generation** - Watch your images come to life
20
+ - πŸ“œ **Image History** - Keep track of all your generated images
21
+ - πŸŒ“ **Dark/Light Mode** - Comfortable viewing in any lighting
22
+ - πŸ” **Secure API Keys** - Manage your API keys privately through settings
23
 
24
+ ## 🎯 Supported Providers
 
 
25
 
26
+ | Provider | Model | Features |
27
+ |----------|-------|----------|
28
+ | **OpenAI** | DALL-E 3 | High-quality, detailed images |
29
+ | **Google** | Imagen 2 | Fast generation, excellent quality |
30
+ | **Qwen** | Qwen Image Gen | Cost-effective, good quality |
31
 
32
+ ## πŸš€ Quick Start
33
 
34
+ 1. **Visit the Space** and open the application
35
+ 2. **Add API Keys** - Click settings and add your API keys for providers you want to use
36
+ 3. **Generate Images** - Enter your prompt and watch the magic happen!
37
 
38
+ ### Getting API Keys
39
 
40
+ - **OpenAI**: https://platform.openai.com/api-keys
41
+ - **Google**: https://ai.google.dev
42
+ - **Qwen**: https://dashscope.aliyun.com
 
 
 
 
 
 
 
 
 
43
 
44
+ ## πŸ’» Local Development
45
 
46
  ```bash
47
+ # Install dependencies
48
+ npm install
 
 
49
 
50
+ # Run development server
51
+ npm run dev
52
+ # App available at http://localhost:9002
53
 
54
+ # Build for production
55
  npm run build
56
+
57
+ # Start production server
58
  npm start
59
  ```
60
 
61
+ ## πŸ› οΈ Technologies
62
+
63
+ - **Frontend**: Next.js 15, React 19, TypeScript
64
+ - **Styling**: Tailwind CSS, Radix UI
65
+ - **AI**: Genkit AI, Google Generative AI SDK
66
+ - **Backend**: Next.js API Routes
67
+ - **UI Components**: shadcn/ui
68
 
69
+ ## πŸ“ How It Works
70
 
71
+ 1. **Prompt Enhancement** - Your prompt is automatically improved for better results
72
+ 2. **Provider Selection** - The app intelligently selects the best available provider
73
+ 3. **Image Generation** - Request sent to the selected provider
74
+ 4. **Display & History** - Generated images shown with automatic history tracking
75
 
76
+ ## 🐳 Docker Deployment
77
+
78
+ This project is configured to run on Hugging Face Spaces using Docker:
79
 
 
 
 
80
  ```bash
81
+ # The Dockerfile handles:
82
+ - Node.js environment setup
83
+ - Dependency installation
84
+ - Next.js build
85
+ - Production server startup on port 7860
86
  ```
87
 
88
+ ## βš™οΈ Configuration
89
+
90
+ All configuration is handled through the UI:
91
+ - API keys are stored locally in your browser
92
+ - No sensitive data is stored on the server
93
+ - Settings are managed via the settings panel
94
+
95
+ ## πŸ“œ License
96
+
97
+ MIT License - feel free to use this project for personal or commercial purposes.
98
 
99
+ ## 🀝 Contributing
100
 
101
+ Have ideas to improve Multi Image Generator? Feel free to:
102
+ - Report issues
103
+ - Suggest features
104
+ - Submit pull requests
 
 
 
105
 
106
+ ## πŸ“§ Support
107
 
108
+ For issues or questions about using the app, please check the settings panel for API key configuration help.