🎨 Vibe Prompting

📑 Table of Contents

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

✨ Features

🔒 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 →

🛠️ Tech Stack

🚀 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)
VITE_SUPABASE_URL=your_supabase_project_url
VITE_SUPABASE_ANON_KEY=your_supabase_anon_key

# AI API Keys (choose at least one)
VITE_GEMINI_API_KEY=your_gemini_api_key        # https://aistudio.google.com/apikey
VITE_OPENROUTER_API_KEY=your_openrouter_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

🔧 Technical Guides

🔗 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

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

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

✨ For Registered Users

1. 📝 Sign Up - Get 50 free credits instantly
2. 🎨 Generate Prompts - Use your credits wisely
3. 🏷️ Add Tags - Organize with up to 5 tags
4. 🌍 Make Public - Share with the community
5. 📚 Browse Gallery - Discover & save others' prompts
6. ⚙️ 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

1. 🍴 Fork the repository
2. 🌿 Create a feature branch

   git checkout -b feature/AmazingFeature
   

3. 💻 Code your changes
4. ✅ Commit with clear messages

   git commit -m 'feat: Add AmazingFeature'
   

5. 📤 Push to your branch

   git push origin feature/AmazingFeature
   

6. 🎯 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:

Special thanks to:

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

📧 Contact

💬 Get in Touch

• 💼 GitHub: @Addy-shetty
• 📧 Email: [email protected]
• 🐛 Issues: Report bugs
• 💡 Discussions: Join conversations