Skip to content

vadiraj-22/QuickAI

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

37 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ Quick AI - Your All-in-One AI Assistant

Quick AI Banner

A powerful AI-powered platform that brings multiple AI tools under one roof

Live Demo React Node.js OpenAI Clerk

🌐 Try it Live | πŸ“– Documentation | πŸš€ Quick Start


πŸ“‹ Table of Contents


🎯 About

Quick AI is a comprehensive AI-powered platform that provides multiple AI tools in a single, intuitive interface. From content creation to image manipulation, Quick AI leverages cutting-edge AI technologies to help users accomplish various tasks efficiently.

🌐 Live Demo

Experience Quick AI now: https://quick-ai-gray.vercel.app/

No installation required - try all features directly in your browser!


✨ Features

πŸ“ Content Generation

  • Write Article - Generate full-length articles on any topic with AI assistance
  • Blog Titles - Create catchy and SEO-friendly blog titles instantly

🎨 Image Tools

  • Generate Images - Create stunning AI-generated images from text descriptions
  • Remove Background - Automatically remove backgrounds from images
  • Remove Object - Intelligently remove unwanted objects from photos

πŸ“„ Document Analysis

  • Review Resume - Get AI-powered feedback and suggestions for your resume

πŸ‘₯ Community

  • Community Hub - Share and explore AI-generated content with other users

πŸ“Έ Screenshots

Home Page

Home Page Modern and intuitive landing page showcasing all AI tools

Dashboard

Dashboard Clean dashboard interface with easy access to all features

Article Writer

Article Writer AI-powered article generation with real-time preview

Image Generation

Image Generation Create stunning images from text descriptions

Background Removal

Background Removal One-click background removal with AI precision

Object Removal

Object Removal Remove unwanted objects from photos with AI precision

Resume Review

Resume Review Get detailed AI feedback on your resume


πŸ› οΈ Tech Stack

Frontend

  • React 19.1.0 - Modern UI library
  • Vite - Lightning-fast build tool
  • TailwindCSS 4.1.11 - Utility-first CSS framework
  • React Router DOM - Client-side routing
  • Clerk - Authentication and user management
  • Axios - HTTP client
  • Lucide React - Beautiful icon library
  • React Markdown - Markdown rendering
  • React Hot Toast - Toast notifications

Backend

  • Node.js - JavaScript runtime
  • Express 5.1.0 - Web application framework
  • OpenAI API - AI model integration
  • Clerk Express - Backend authentication
  • Cloudinary - Image storage and manipulation
  • Neon Database - Serverless PostgreSQL
  • Multer - File upload handling
  • PDF Parse - PDF document processing

πŸ“¦ Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js (v18 or higher) - Download
  • npm or yarn - Package manager
  • Git - Version control

You'll also need accounts and API keys for:


πŸš€ Installation

1. Clone the Repository

git clone https://github.com/yourusername/quick-ai.git
cd quick-ai

2. Install Server Dependencies

cd server
npm install

3. Install Client Dependencies

cd ../client
npm install

πŸ” Environment Variables

Server Environment Variables

Create a .env file in the server directory:

# Server Configuration
PORT=3000

# Clerk Authentication
CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
CLERK_SECRET_KEY=your_clerk_secret_key

# OpenAI Configuration
OPENAI_API_KEY=your_openai_api_key

# Cloudinary Configuration
CLOUDINARY_CLOUD_NAME=your_cloud_name
CLOUDINARY_API_KEY=your_cloudinary_api_key
CLOUDINARY_API_SECRET=your_cloudinary_api_secret

# Neon Database
DATABASE_URL=your_neon_database_url

Client Environment Variables

Create a .env file in the client directory:

# Clerk Configuration
VITE_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key

# API URL
VITE_API_URL=http://localhost:3000

▢️ Running the Application

Development Mode

1. Start the Backend Server

Open a terminal and run:

cd server
npm run server

The server will start on http://localhost:3000

2. Start the Frontend Development Server

Open another terminal and run:

cd client
npm run dev

The client will start on http://localhost:5173

Production Mode

Build the Client

cd client
npm run build

Start the Production Server

cd server
npm start

Environment Variables for Production

Make sure to set all required environment variables in your deployment platform:

Frontend:

  • VITE_CLERK_PUBLISHABLE_KEY
  • VITE_API_URL

Backend:

  • PORT
  • CLERK_PUBLISHABLE_KEY
  • CLERK_SECRET_KEY
  • OPENAI_API_KEY
  • CLOUDINARY_CLOUD_NAME
  • CLOUDINARY_API_KEY
  • CLOUDINARY_API_SECRET
  • DATABASE_URL

πŸ“ Project Structure

quick-ai/
β”œβ”€β”€ client/                 # Frontend React application
β”‚   β”œβ”€β”€ public/            # Static assets
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ components/    # Reusable UI components
β”‚   β”‚   β”‚   β”œβ”€β”€ AiTools.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ CreationItem.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Footer.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Hero.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Navbar.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Plan.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Sidebar.jsx
β”‚   β”‚   β”‚   └── Testimonials.jsx
β”‚   β”‚   β”œβ”€β”€ pages/         # Page components
β”‚   β”‚   β”‚   β”œβ”€β”€ BlogTitles.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Community.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Dashboard.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ GenerateImages.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Home.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ Layout.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ RemoveBackground.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ RemoveObject.jsx
β”‚   β”‚   β”‚   β”œβ”€β”€ ReviewResume.jsx
β”‚   β”‚   β”‚   └── WriteArticle.jsx
β”‚   β”‚   β”œβ”€β”€ App.jsx        # Main app component
β”‚   β”‚   └── main.jsx       # Entry point
β”‚   β”œβ”€β”€ package.json
β”‚   └── vite.config.js
β”‚
β”œβ”€β”€ server/                # Backend Express application
β”‚   β”œβ”€β”€ configs/          # Configuration files
β”‚   β”œβ”€β”€ controllers/      # Route controllers
β”‚   β”œβ”€β”€ middlewares/      # Custom middlewares
β”‚   β”œβ”€β”€ routes/           # API routes
β”‚   β”‚   β”œβ”€β”€ aiRoutes.js
β”‚   β”‚   └── userRoutes.js
β”‚   β”œβ”€β”€ server.js         # Server entry point
β”‚   └── package.json
β”‚
└── README.md             # Project documentation

🎨 Features in Detail

1. Article Writer

Generate comprehensive articles on any topic. Simply provide a topic or keywords, and the AI will create well-structured, engaging content.

2. Blog Title Generator

Struggling with blog titles? Get multiple creative and SEO-optimized title suggestions instantly.

3. AI Image Generation

Transform your ideas into stunning visuals. Describe what you want, and watch as AI brings your imagination to life.

4. Background Removal

Professional background removal in seconds. Perfect for product photos, profile pictures, and more.

5. Object Removal

Remove unwanted objects or people from your photos seamlessly with AI-powered inpainting.

6. Resume Review

Upload your resume and receive detailed feedback on formatting, content, keywords, and suggestions for improvement.


🀝 Contributing

Contributions are welcome! Please follow these steps:

  1. Fork the repository
  2. Create a new 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

πŸ“„ License

This project is licensed under the ISC License.


πŸ‘¨β€πŸ’» Author

Your Name


πŸ™ Acknowledgments

  • OpenAI for providing powerful AI models
  • Clerk for seamless authentication
  • Cloudinary for image management
  • Neon for serverless PostgreSQL
  • All contributors and users of Quick AI

Made with ❀️ and AI

⭐ Star this repo if you find it helpful!

Releases

No releases published

Packages

No packages published

Languages