Skip to content

melloom/Caption-Gnerator-App

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

🚀 Caption Generator App

A comprehensive AI-powered social media content creation platform that helps you generate engaging captions, hashtags, and content for various social media platforms.

✨ Features

🎯 Core Features

  • AI Caption Generation - Generate creative and engaging captions using advanced AI models
  • Hashtag Optimization - Smart hashtag suggestions and optimization tools
  • Multi-Platform Support - Create content for Instagram, Twitter, Facebook, LinkedIn, and more
  • Content Calendar - Plan and schedule your social media content
  • Analytics Dashboard - Track your content performance and engagement

🤖 AI Tools Suite

  • Content Rewriter - Rephrase and improve existing content
  • Image Generator - Create AI-generated images for your posts
  • Tone Analyzer - Analyze and adjust the tone of your content
  • Language Translator - Translate content into multiple languages
  • SEO Optimizer - Optimize content for search engines
  • Content Ideas Generator - Get creative content ideas and suggestions
  • Audience Analyzer - Understand your target audience better
  • Brand Voice Analyzer - Maintain consistent brand voice across content
  • Engagement Predictor - Predict potential engagement for your posts
  • Content Repurposer - Repurpose content for different platforms
  • Voice Analyzer - Analyze voice content and generate transcripts

🔧 Technical Features

  • Real-time Generation - Instant AI-powered content generation
  • Batch Processing - Generate multiple captions at once
  • Custom Templates - Save and reuse your favorite caption templates
  • Export Options - Export content in various formats
  • Responsive Design - Works seamlessly on desktop and mobile devices

🛡️ Security & User Management

  • User Authentication - Secure login and registration system
  • Two-Factor Authentication - Enhanced security with 2FA
  • Credit System - Fair usage tracking and management
  • Subscription Management - Flexible pricing plans
  • Privacy Controls - User data protection and privacy settings

🚧 Current Status

✅ Working Features

  • User authentication and registration
  • Dashboard and navigation
  • Basic caption generation interface
  • AI tools interface and routing
  • Settings and user management
  • Credit system and billing
  • Responsive design and UI components
  • Multi-language support
  • Tutorial system

⚠️ Known Issues

  • Content Generation: After generation, the results may not display properly
  • AI Tools: Some AI tools are still being tested and may not function correctly
  • Real-time Processing: Some features may have delays in processing

🔄 In Development

  • Enhanced AI model integration
  • Improved content generation reliability
  • Advanced analytics features
  • Mobile app development

🛠️ Technology Stack

Frontend

  • React 18 - Modern React with hooks and functional components
  • TypeScript - Type-safe JavaScript development
  • Vite - Fast build tool and development server
  • Tailwind CSS - Utility-first CSS framework
  • React Router - Client-side routing
  • React Icons - Beautiful icon library

Backend & APIs

  • Node.js - Server-side JavaScript runtime
  • Express.js - Web application framework
  • Firebase - Authentication, database, and hosting
  • OpenAI API - Advanced AI content generation
  • Anthropic Claude - Alternative AI model
  • Google Cloud Vision - Image analysis
  • Stripe - Payment processing

AI & Machine Learning

  • TensorFlow.js - Client-side machine learning
  • Transformers.js - Natural language processing
  • Hugging Face - AI model integration
  • Replicate - AI model hosting and inference

Development Tools

  • ESLint - Code linting and quality
  • PostCSS - CSS processing
  • Autoprefixer - CSS vendor prefixing
  • TypeScript - Static type checking

📦 Installation

Prerequisites

  • Node.js (v16 or higher)
  • npm or yarn
  • Git

Setup Instructions

  1. Clone the repository

    git clone https://github.com/melloom/Caption-Gnerator-App.git
    cd Caption-Gnerator-App
  2. Install dependencies

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

    VITE_OPENAI_API_KEY=your_openai_api_key
    VITE_ANTHROPIC_API_KEY=your_anthropic_api_key
    VITE_HUGGINGFACE_API_KEY=your_huggingface_api_key
    VITE_REPLICATE_API_TOKEN=your_replicate_token
    VITE_FIREBASE_API_KEY=your_firebase_api_key
    VITE_FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
    VITE_FIREBASE_PROJECT_ID=your_firebase_project_id
    VITE_STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key
  4. Start the development server

    npm run dev
  5. Start the backend server (in a separate terminal)

    npm run server
  6. Or run both simultaneously

    npm start

🚀 Usage

Getting Started

  1. Register/Login - Create an account or sign in
  2. Navigate to Create Post - Start creating your first caption
  3. Enter your content - Describe what you want to post about
  4. Generate Caption - Let AI create engaging content for you
  5. Customize - Edit and refine the generated content
  6. Export/Share - Copy or export your final caption

AI Tools

  • Content Rewriter: Paste existing content and get improved versions
  • Image Generator: Describe an image and generate it with AI
  • Tone Analyzer: Analyze the emotional tone of your content
  • Hashtag Optimizer: Get relevant hashtags for better reach

Content Calendar

  • Plan your content in advance
  • Schedule posts for optimal timing
  • Track your content strategy

🔧 Configuration

Environment Variables

Make sure to configure all required environment variables in your .env file:

# AI Services
VITE_OPENAI_API_KEY=your_openai_api_key
VITE_ANTHROPIC_API_KEY=your_anthropic_api_key
VITE_HUGGINGFACE_API_KEY=your_huggingface_api_key
VITE_REPLICATE_API_TOKEN=your_replicate_token

# Firebase Configuration
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_FIREBASE_AUTH_DOMAIN=your_firebase_auth_domain
VITE_FIREBASE_PROJECT_ID=your_firebase_project_id
VITE_FIREBASE_STORAGE_BUCKET=your_firebase_storage_bucket
VITE_FIREBASE_MESSAGING_SENDER_ID=your_firebase_messaging_sender_id
VITE_FIREBASE_APP_ID=your_firebase_app_id

# Payment Processing
VITE_STRIPE_PUBLISHABLE_KEY=your_stripe_publishable_key

# Application Settings
VITE_APP_NAME=Caption Generator App
VITE_APP_VERSION=1.0.0

Firebase Setup

  1. Create a Firebase project
  2. Enable Authentication (Email/Password, Google)
  3. Set up Firestore database
  4. Configure security rules
  5. Add your Firebase configuration to environment variables

📱 Available Scripts

  • npm run dev - Start development server
  • npm run server - Start backend server
  • npm start - Start both frontend and backend
  • npm run build - Build for production
  • npm run preview - Preview production build
  • npm run lint - Run ESLint

🏗️ Project Structure

src/
├── components/          # Reusable UI components
├── contexts/           # React contexts for state management
├── hooks/              # Custom React hooks
├── pages/              # Page components
│   ├── tools/          # AI tools pages
│   └── tutorials/      # Tutorial pages
├── services/           # API and external service integrations
├── styles/             # Global styles and CSS
├── types/              # TypeScript type definitions
└── utils/              # Utility functions

🤝 Contributing

  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

📄 License

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

🆘 Support

  • Documentation: Check the /docs folder for detailed guides
  • FAQ: Visit the FAQ page in the application
  • Help Center: Access the help center for tutorials and guides
  • Customer Support: Contact support through the app

🔮 Roadmap

Phase 1 (Current)

  • Basic caption generation
  • User authentication
  • AI tools framework
  • Fix content generation display issues
  • Complete AI tools testing

Phase 2 (Next)

  • Enhanced AI models
  • Advanced analytics
  • Mobile app
  • Social media integration
  • Team collaboration features

Phase 3 (Future)

  • AI-powered image editing
  • Video content generation
  • Advanced scheduling
  • White-label solutions
  • API for developers

🙏 Acknowledgments

  • OpenAI for GPT models
  • Anthropic for Claude AI
  • Firebase for backend services
  • Tailwind CSS for styling
  • React community for amazing tools

Note: This application is actively being developed. Some features may be in testing phase and not fully functional. Please report any issues or bugs you encounter.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors