🎨 Vibe Prompting

---

📑 Table of Contents

• ✨ Features
• 🛠️ Tech Stack
• 🚀 Quick Start
• 📁 Project Structure
• 📖 Documentation
• 🎮 Usage Guide
• 🤝 Contributing
• 📝 License
• 📧 Contact

---

✨ Features

🚀 Core Capabilities ✅ AI Prompt Generation - Powered by Google Gemini 2.0 Flash & OpenRouter ✅ 14 Specialized Categories - Frontend, Backend, DevOps, Security & more ✅ Smart Tag System - Organize with up to 5 tags per prompt ✅ Real-time Streaming - Watch prompts generate live ✅ Public Gallery - Discover community creations

🎯 User Experience ✅ Anonymous Preview - 3 free generations, no signup needed ✅ 50 Free Credits - For registered users ✅ Dark/Light Theme - Beautiful adaptive UI ✅ One-Click Copy - Instant clipboard functionality ✅ Fully Responsive - Desktop, tablet & mobile ready

🔒 Enterprise-Grade Security

Built with security at its core. Learn more →

• ✅ Row Level Security (RLS) - Database-level access control
• ✅ IDOR Protection - Users can only access their own data
• ✅ Input Validation - Zod schemas + XSS prevention
• ✅ Rate Limiting - Protection against abuse
• ✅ Password Strength - Enforced requirements with visual feedback

📊 Fair Usage Credit System

View detailed credit system documentation →

| User Type | Generations | Prompt Views | Storage | Cost | |-----------|-------------|--------------|---------|------| | 🎭 Anonymous | 3 free | 3 free views | localStorage | Free | | ✨ Registered | 7 credits | Unlimited | Database | Free | | Price | Comming soon |

---

🛠️ Tech Stack

Frontend ⚛️ React 18.3 - UI library 📘 TypeScript 5.5 - Type safety ⚡ Vite 5.4 - Build tool 🎨 Tailwind CSS - Styling 🎬 Framer Motion - Animations 🛣️ React Router - Routing

Backend 🗄️ Supabase - BaaS platform 🐘 PostgreSQL - Database with RLS ⚡ Edge Functions - Serverless

AI Integration 🤖 Gemini 2.0 Flash - Primary model 🦙 Llama 3.2 - Fallback via OpenRouter

---

🚀 Quick Start

📋 Prerequisites: Node.js 18+, npm, Supabase account (free), and at least one AI API key

1️⃣ Clone the Repository

git clone https://github.com/Addy-shetty/Vibe-Prompting.git
cd Vibe-Prompting

2️⃣ Install Dependencies

npm install

3️⃣ Set Up Environment Variables

Copy .env.example to .env and fill in your credentials:

cp .env.example .env

Required variables:

# Supabase (Get from: https://app.supabase.com/project/_/settings/api) VITESUPABASEURL=yoursupabaseproject_url VITESUPABASEANONKEY=yoursupabaseanonkey

AI API Keys (choose at least one)
VITEGEMINIAPIKEY=yourgeminiapikey        # https://aistudio.google.com/apikey
VITEOPENROUTERAPIKEY=youropenrouter_key    # https://openrouter.ai/keys

💡 Tip: See .env.example for detailed setup instructions

4️⃣ Set Up Supabase Database

Run migrations in the Supabase SQL Editor:

# Or use Supabase CLI
npx supabase db reset

📚 Detailed database setup guide →

5️⃣ Start Development Server

npm run dev

🎉 Visit http://localhost:5173 and start creating prompts!

🚢 Build for Production

npm run build
npm run preview

---

📁 Project Structure

vibe-prompting/
├── src/
│   ├── components/        # React components
│   ├── pages/             # Page components
│   ├── context/           # React context
│   ├── hooks/             # Custom hooks
│   ├── lib/               # Utilities
│   └── styles/            # Global styles
├── supabase/
│   └── migrations/        # Database migrations
├── docs/                  # Documentation
└── public/                # Static assets

---

📖 Documentation

📚 Core Documentation

| Document | Description | |----------|-------------| | 🔒 Security Policy | Vulnerability reporting & security measures | | 🤝 Contributing Guide | How to contribute to this project | | 📜 MIT License | Open source license details |

🔧 Technical Guides

| Guide | Description | |-------|-------------| | 🔐 Authentication | Auth implementation & user flows | | 💳 Credits System | How credits work & limitations | | 🗄️ Database Setup | Supabase configuration & migrations | | 🛡️ Security Details | Complete security implementation |

🔗 Quick Links

• 📋 .env.example - Environment variables template
• 🗂️ supabase/migrations - Database migration files
• 🧩 src/components - React components
• 🎣 src/hooks - Custom React hooks

---

🎮 Usage Guide

🎭 For Anonymous Users

• 🏠 Visit Homepage - Explore example prompts
• 🎯 Click a Category - Choose your prompt type
• ✨ Generate - Create up to 3 free prompts
• 📋 Copy - One-click clipboard copy
• 💾 Sign Up - To save prompts permanently

⚠️ Note: Anonymous prompts are stored in localStorage and may be lost

✨ For Registered Users

• 📝 Sign Up - Get 50 free credits instantly
• 🎨 Generate Prompts - Use your credits wisely
• 🏷️ Add Tags - Organize with up to 5 tags
• 🌍 Make Public - Share with the community
• 📚 Browse Gallery - Discover & save others' prompts
• ⚙️ Manage - Edit or delete your creations

💡 Pro Tips

• 🎯 Be Specific - More detailed inputs = better prompts
• 🏷️ Use Tags - Makes finding prompts easier later
• 🌍 Go Public - Help the community & get discovered
• 💳 Track Credits - Visible in navbar when logged in

---

🤝 Contributing

We ❤️ contributions! Whether it's bug reports, feature requests, or code contributions - all are welcome!

🚀 Quick Contribution Steps

• 🍴 Fork the repository
• 🌿 Create a feature branch

git checkout -b feature/AmazingFeature

• 💻 Code your changes
• ✅ Commit with clear messages

git commit -m 'feat: Add AmazingFeature'

• 📤 Push to your branch

git push origin feature/AmazingFeature

• 🎯 Open a Pull Request

📋 Contribution Guidelines

Please read our Contributing Guide for:

• 📜 Code of Conduct
• 🛠️ Development setup
• 💻 Coding standards
• ✉️ Commit message conventions
• 🧪 Testing requirements

🐛 Found a Bug?

Open an issue with:

• Clear description
• Steps to reproduce
• Expected vs actual behavior
• Screenshots (if applicable)

💡 Feature Request?

We'd love to hear your ideas! Create a feature request and describe:

• The problem it solves
• Proposed solution
• Alternative approaches

---

📝 License

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

📜 What This Means

✅ Commercial use - Use it in your business ✅ Modification - Change and customize freely ✅ Distribution - Share with anyone ✅ Private use - Use for personal projects

⚠️ Conditions:

• Include copyright notice
• Include license copy

📖 Read the full MIT License →

---

🙏 Acknowledgments

This project wouldn't be possible without these amazing tools and services:

| Technology | Purpose | License | |------------|---------|---------| | Google Gemini | AI prompt generation | Google AI | | Supabase | Backend infrastructure | Apache 2.0 | | React | UI framework | MIT | | TypeScript | Type safety | Apache 2.0 | | Tailwind CSS | Styling | MIT | | Framer Motion | Animations | MIT | | Vite | Build tool | MIT |

Special thanks to:

• 🌟 All contributors
• 🐛 Bug reporters and testers
• 💡 Feature requesters
• ⭐ Everyone who starred this repo

---

📧 Contact

💬 Get in Touch

• 💼 GitHub: @Addy-shetty
• 📧 Email: Harshithms@gmail.com
• 🐛 Issues: Report bugs
• 💡 Discussions: Join conversations

---