Skip to content

Latest commit

ย 

History

17 Commits

Folders and files

NameName
Last commit message
Last commit date
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

๐Ÿš€ QuickAI - Intelligent Content Creation Platform

QuickAI Logo

Transform your ideas into reality with the power of AI

MIT License React Node.js PostgreSQL Deployed


๐ŸŒŸ Overview

QuickAI is a comprehensive AI-powered platform that empowers users to create high-quality content effortlessly. From generating articles and images to removing backgrounds and reviewing resumes, QuickAI leverages cutting-edge AI technologies to streamline creative workflows.

โœจ Key Features

  • ๐Ÿ“ Article Generation - Create professional articles with AI assistance
  • ๐ŸŽจ Image Creation - Generate stunning images from text descriptions
  • ๐Ÿ–ผ๏ธ Background Removal - Remove backgrounds from images instantly
  • ๐Ÿ“„ Resume Review - Get detailed AI-powered resume analysis
  • ๐ŸŽฏ Blog Title Generator - Create catchy titles for your content
  • ๐Ÿ‘ฅ Community Hub - Share and discover AI-generated content
  • โšก High Performance - 95% faster queries with advanced caching and indexing

๐Ÿ› ๏ธ Tech Stack

Frontend

  • React 19 - Modern UI framework
  • Vite - Lightning-fast build tool
  • Tailwind CSS - Utility-first styling
  • Clerk - Authentication and user management
  • Axios - HTTP client for API calls
  • React Router - Client-side routing
  • Lucide React - Beautiful icons

Backend

  • Node.js - Runtime environment
  • Express.js - Web application framework
  • PostgreSQL (Neon) - Cloud database with advanced indexing
  • Clerk - Authentication middleware
  • Cloudinary - Image storage and processing

AI Services

  • Google Gemini - Text generation and analysis
  • ClipDrop API - AI image generation
  • Cloudinary AI - Background removal processing

Performance Optimizations

  • Response Caching - 96% latency reduction for repeated requests
  • Database Indexing - 95% faster query performance
  • CDN Integration - Optimized asset delivery

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 18.0 or higher
  • npm or yarn
  • PostgreSQL database (or Neon account)
  • Clerk account for authentication

Installation

  1. Clone the repository

    git clone https://github.com/harshshukla07/QuickAI.git
    cd QuickAI
  2. Install dependencies

    # Install server dependencies
    cd server
    npm install
    
    # Install client dependencies
    cd ../client
    npm install
  3. Environment Setup

    Create .env files in both server and client directories:

    Server .env:

    DATABASE_URL=your_postgresql_connection_string
    CLERK_SECRET_KEY=your_clerk_secret_key
    GEMINI_API_KEY=your_gemini_api_key
    CLIPDROP_API_KEY=your_clipdrop_api_key
    CLOUDINARY_CLOUD_NAME=your_cloudinary_name
    CLOUDINARY_API_KEY=your_cloudinary_api_key
    CLOUDINARY_API_SECRET=your_cloudinary_secret

    Client .env:

    VITE_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
    VITE_BASE_URL=http://localhost:4000
  4. Database Setup

    cd server
    node create-indexes.js
  5. Start the application

    # Start server (terminal 1)
    cd server
    npm run server
    
    # Start client (terminal 2)
    cd client
    npm run dev
  6. Access the application

    • Frontend: http://localhost:5173
    • Backend: http://localhost:4000

๐Ÿ“ Project Structure

QuickAI/
โ”œโ”€โ”€ client/                 # React frontend
โ”‚   โ”œโ”€โ”€ src/
โ”‚   โ”‚   โ”œโ”€โ”€ components/     # Reusable UI components
โ”‚   โ”‚   โ”œโ”€โ”€ pages/         # Page components
โ”‚   โ”‚   โ”œโ”€โ”€ assets/        # Static assets
โ”‚   โ”‚   โ””โ”€โ”€ App.jsx        # Main application component
โ”‚   โ”œโ”€โ”€ public/            # Public assets
โ”‚   โ””โ”€โ”€ package.json
โ”‚
โ”œโ”€โ”€ server/                # Express backend
โ”‚   โ”œโ”€โ”€ controllers/       # Business logic
โ”‚   โ”œโ”€โ”€ middlewares/       # Custom middleware
โ”‚   โ”œโ”€โ”€ routes/           # API routes
โ”‚   โ”œโ”€โ”€ configs/          # Configuration files
โ”‚   โ””โ”€โ”€ package.json
โ”‚
โ””โ”€โ”€ README.md

๐ŸŽฏ Features Deep Dive

๐Ÿ“ Article Generation

  • AI-Powered Writing - Generates comprehensive articles using Google Gemini
  • Customizable Length - Short (500-800), Medium (800-1200), Long (1200+ words)
  • Markdown Support - Rich formatting with headers, lists, and emphasis
  • Usage Tracking - Free tier: 10 articles, Premium: unlimited

๐ŸŽจ Image Creation

  • Text-to-Image - Create images from detailed descriptions
  • Style Options - Realistic, Anime, Cartoon, Fantasy, 3D, Portrait styles
  • High Quality - Powered by ClipDrop's advanced AI models
  • Community Sharing - Option to publish creations publicly

๐Ÿ–ผ๏ธ Background Removal

  • One-Click Processing - Remove backgrounds instantly
  • AI-Powered - Uses Cloudinary's advanced background removal
  • Multiple Formats - Supports JPG, PNG, and other image formats
  • Premium Feature - Available for premium subscribers

๐Ÿ“„ Resume Analysis

  • Comprehensive Review - ATS score, strengths, and improvement areas
  • PDF Processing - Extracts and analyzes text from PDF resumes
  • Actionable Feedback - Specific recommendations for enhancement
  • Professional Insights - Industry-standard evaluation criteria

โšก Performance Optimizations

Response Caching System

// Intelligent caching reduces response time by 96%
Cache Key: article:${prompt_hash}
Cache Hit: ~50ms response
Cache Miss: ~1200ms + cache storage
TTL: 1 hour

Database Indexing

-- Strategic indexes for optimal query performance
CREATE INDEX idx_creations_user_id ON creations(user_id);
CREATE INDEX idx_creations_type ON creations(type);
CREATE INDEX idx_creations_user_date ON creations(user_id, created_at DESC);

Performance Results:

  • User dashboard queries: 120ms โ†’ 2ms (98% faster)
  • Public gallery: 200ms โ†’ 5ms (97% faster)
  • Content filtering: 80ms โ†’ 3ms (96% faster)

๐Ÿ” Security Features

  • Clerk Authentication - Enterprise-grade user management
  • API Rate Limiting - Prevents abuse and ensures fair usage
  • Input Validation - Sanitizes and validates all user inputs
  • Environment Variables - Secure configuration management
  • CORS Protection - Controlled cross-origin requests

๐Ÿ“Š API Documentation

Authentication

All API requests require authentication via Clerk JWT tokens.

Endpoints

Article Generation

POST /api/ai/generate-article
Content-Type: application/json
Authorization: Bearer <token>

{
  "prompt": "Write about artificial intelligence",
  "length": 800
}

Image Generation

POST /api/ai/generate-image
Content-Type: application/json
Authorization: Bearer <token>

{
  "prompt": "A futuristic city at sunset",
  "publish": true
}

Background Removal

POST /api/ai/remove-background
Content-Type: multipart/form-data
Authorization: Bearer <token>

{
  "image": <file>
}

๐Ÿš€ Deployment

Frontend (Vercel)

cd client
npm run build
# Deploy to Vercel

Backend (Railway/Heroku)

cd server
# Set environment variables
# Deploy to your preferred platform

Database (Neon)

  • Automatic scaling
  • Built-in connection pooling
  • Serverless PostgreSQL

๐Ÿค Contributing

We welcome contributions! Please follow these steps:

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

Development Guidelines

  • Follow ESLint configuration
  • Write meaningful commit messages
  • Add comments for complex logic
  • Test your changes thoroughly

๐Ÿ“ˆ Performance Metrics

Metric Before Optimization After Optimization Improvement
Average API Response 1.2s 600ms 50%
Database Queries 120ms 2ms 98%
Cache Hit Rate 0% 85% โˆž
User Dashboard Load 2.5s 800ms 68%

๐Ÿ”ฎ Future Enhancements

  • Voice-to-Text - Audio input for content generation
  • Multi-language Support - Global accessibility
  • Advanced Analytics - Usage insights and metrics
  • API Webhooks - Real-time integrations
  • Mobile App - React Native companion
  • Team Collaboration - Shared workspaces
  • Custom AI Models - Fine-tuned for specific use cases

๐Ÿ› Known Issues

  • Large file uploads may timeout on slower connections
  • Cache warming needed after server restart
  • Some AI generations may take longer during peak usage

๐Ÿ“„ License

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


๐Ÿ‘จโ€๐Ÿ’ป Author

Harsh Shukla


๐Ÿ™ Acknowledgments


โญ Star this repository if you found it helpful!

Built with โค๏ธ and AI

๐ŸŒŸ Star โ€ข ๐Ÿ› Report Bug โ€ข โœจ Request Feature

Releases

Packages

Contributors

Languages