Skip to content

SyedImtiyaz-1/CtrlEnter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

5 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

CtrlEnter (Quick answers on your screen)

A powerful, desktop AI assistant built with React and Electron that provides intelligent responses with web search capabilities and screen capture functionality.

PromptlyAI Interface Electron Vite

✨ Features

🧠 AI-Powered Responses

  • Real-time streaming responses for instant feedback
  • Multiple AI model support (Gemini, Grok 3, GPT-4, Claude, Llama)
  • Intelligent query processing with context awareness

🌐 Web Search Integration

  • Toggle web search for current information and facts
  • Source citations with automatic link generation
  • Recent data fetching for up-to-date responses

πŸ“Έ Screen Capture

  • One-click screen capture functionality
  • Image analysis with AI-powered insights
  • Seamless integration with query processing

πŸ’» Developer-Friendly

  • Syntax highlighting for code blocks
  • One-click code copying with language detection
  • Markdown rendering with full formatting support
  • Responsive design for optimal user experience

⚑ Performance & UX

  • Keyboard shortcuts for quick access
  • Always-on-top desktop application
  • Clean, modern interface with dark theme
  • Multi-app usage without interruption

πŸš€ Quick Start

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn package manager

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/PromptlyAI.git
    cd PromptlyAI
  2. Install dependencies

    npm install
  3. Set up environment variables Create a .env file in the root directory:

    VITE_GEMINI_API_KEY=your_gemini_api_key_here
  4. Start the development server

    npm run dev
  5. Build for production

    npm run build
  6. Run as Electron app

    npm run electron

πŸ”§ Configuration

API Setup

Google Gemini API (Recommended)

  1. Visit Google AI Studio
  2. Generate your API key
  3. Add it to your .env file as VITE_GEMINI_API_KEY

Environment Variables

# Required for Gemini AI functionality
VITE_GEMINI_API_KEY=your_gemini_api_key_here

🎯 Usage

Basic Search

  1. Type your query in the search input
  2. Press Enter or click the search button
  3. View the AI-generated response with syntax highlighting

Web Search Mode

  • Toggle: Click the "Web Search" button or use Ctrl+W
  • Functionality: Enables real-time web data retrieval for current information

Screen Capture

  • 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

Code Interaction

  • Copy Code: Click the "Copy" button on any code block
  • Language Detection: Automatic syntax highlighting for multiple languages
  • Formatted Output: Clean, readable code presentation

⌨️ Keyboard Shortcuts

Shortcut Action
Enter Send query
Ctrl+W Toggle web search
Escape Hide application
Ctrl+Enter Show/hide application

πŸ› οΈ Tech Stack

Frontend

  • React 18 - Modern UI framework
  • Vite - Fast build tool and dev server
  • React Markdown - Markdown rendering
  • Prism.js - Syntax highlighting

AI & APIs

  • Google Generative AI - Primary AI model
  • OnClick AI API - Alternative AI service
  • Streaming responses - Real-time data processing

Desktop

  • Electron - Cross-platform desktop application
  • Native integrations - Screen capture, clipboard access

Styling

  • Custom CSS - Modern, responsive design
  • CSS Variables - Consistent theming
  • Flexbox/Grid - Responsive layouts

πŸ“ Project Structure

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

πŸš€ Development

Available Scripts

# 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

Development Workflow

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

🀝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

Areas for Contribution

  • πŸ› Bug fixes and improvements
  • ✨ New AI model integrations
  • 🎨 UI/UX enhancements
  • πŸ“š Documentation improvements
  • πŸ§ͺ Testing and quality assurance

πŸ“„ License

This project is licensed under the MIT License - see the LICENSE file for details.

πŸ™ Acknowledgments

  • 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

πŸ“ž Support


Made with ❀️ by the PromptlyAI Team

About

AI Desktop Agent

Topics

Resources

Stars

Watchers

Forks

Contributors