A powerful, desktop AI assistant built with React and Electron that provides intelligent responses with web search capabilities and screen capture functionality.
- Real-time streaming responses for instant feedback
- Multiple AI model support (Gemini, Grok 3, GPT-4, Claude, Llama)
- Intelligent query processing with context awareness
- Toggle web search for current information and facts
- Source citations with automatic link generation
- Recent data fetching for up-to-date responses
- One-click screen capture functionality
- Image analysis with AI-powered insights
- Seamless integration with query processing
- Syntax highlighting for code blocks
- One-click code copying with language detection
- Markdown rendering with full formatting support
- Responsive design for optimal user experience
- Keyboard shortcuts for quick access
- Always-on-top desktop application
- Clean, modern interface with dark theme
- Multi-app usage without interruption
- Node.js (v16 or higher)
- npm or yarn package manager
-
Clone the repository
git clone https://github.com/yourusername/PromptlyAI.git cd PromptlyAI -
Install dependencies
npm install
-
Set up environment variables Create a
.envfile in the root directory:VITE_GEMINI_API_KEY=your_gemini_api_key_here
-
Start the development server
npm run dev
-
Build for production
npm run build
-
Run as Electron app
npm run electron
- Visit Google AI Studio
- Generate your API key
- Add it to your
.envfile asVITE_GEMINI_API_KEY
# Required for Gemini AI functionality
VITE_GEMINI_API_KEY=your_gemini_api_key_here- Type your query in the search input
- Press
Enteror click the search button - View the AI-generated response with syntax highlighting
- Toggle: Click the "Web Search" button or use
Ctrl+W - Functionality: Enables real-time web data retrieval for current information
- Activate: Click the "Capture Screen" button
- Usage: Capture your screen and ask AI questions about the content
- Integration: Automatically includes captured image in your query
- Copy Code: Click the "Copy" button on any code block
- Language Detection: Automatic syntax highlighting for multiple languages
- Formatted Output: Clean, readable code presentation
| Shortcut | Action |
|---|---|
Enter |
Send query |
Ctrl+W |
Toggle web search |
Escape |
Hide application |
Ctrl+Enter |
Show/hide application |
- React 18 - Modern UI framework
- Vite - Fast build tool and dev server
- React Markdown - Markdown rendering
- Prism.js - Syntax highlighting
- Google Generative AI - Primary AI model
- OnClick AI API - Alternative AI service
- Streaming responses - Real-time data processing
- Electron - Cross-platform desktop application
- Native integrations - Screen capture, clipboard access
- Custom CSS - Modern, responsive design
- CSS Variables - Consistent theming
- Flexbox/Grid - Responsive layouts
PromptlyAI/
βββ public/
β βββ electron.cjs # Electron main process
β βββ vite.svg # Vite logo
βββ src/
β βββ App.jsx # Main application component
β βββ App.css # Application styles
β βββ main.jsx # React entry point
β βββ index.css # Global styles
β βββ assets/ # Static assets
βββ package.json # Dependencies and scripts
βββ vite.config.js # Vite configuration
βββ eslint.config.js # ESLint configuration
# Start development server
npm run dev
# Build for production
npm run build
# Preview production build
npm run preview
# Lint code
npm run lint
# Run Electron app
npm run electron- Fork the repository
- Create a feature branch (
git checkout -b feature/amazing-feature) - Commit your changes (
git commit -m 'Add some amazing feature') - Push to the branch (
git push origin feature/amazing-feature) - Open a Pull Request
We welcome contributions! Please see our Contributing Guidelines for details.
- π Bug fixes and improvements
- β¨ New AI model integrations
- π¨ UI/UX enhancements
- π Documentation improvements
- π§ͺ Testing and quality assurance
This project is licensed under the MIT License - see the LICENSE file for details.
- Google AI for the Gemini API
- React team for the amazing framework
- Vite team for the lightning-fast build tool
- Electron team for cross-platform desktop capabilities
- π§ Email: support@promptlyai.com
- π Issues: GitHub Issues
- π¬ Discussions: GitHub Discussions
Made with β€οΈ by the PromptlyAI Team