Skip to content

Latest commit

 

History

History
133 lines (96 loc) · 3.47 KB

README.md

File metadata and controls

133 lines (96 loc) · 3.47 KB

LumeCast

LumeCast

Transform Documents into Engaging Podcast Conversations

Deployment Status React License Gradio

🎙️ About LumeCast

LumeCast is an innovative AI-powered platform that transforms documents into engaging podcast conversations. Built with cutting-edge technology, it converts PDF documents into natural-sounding dialogues, making content consumption more engaging and accessible.

🌟 Key Features

  • PDF to Podcast Conversion: Transform any PDF document into a dynamic podcast conversation
  • Multi-Language Support: Generate podcasts in multiple languages
  • Customizable Tone: Choose between fun and formal conversation styles
  • Flexible Duration: Options for short (1-2 min) and medium (3-5 min) podcasts
  • Advanced Audio Generation: High-quality, natural-sounding voice synthesis

🚀 Getting Started

Prerequisites

  • Node.js (v16.x or higher)
  • npm or yarn
  • Python 3.9+ (for Gradio backend)

Installation

  1. Clone the repository
https://github.com/LumeML/LumeCast.git
cd LumeCast
  1. Install dependencies
npm install
  1. Set up environment variables
cp .env.example .env
# Edit .env with your configuration
  1. Start the development server
npm run dev

🛠️ Technology Stack

Frontend

  • React 18.x
  • TypeScript
  • Tailwind CSS
  • Vite

Backend

  • Gradio
  • Python
  • Hugging Face Transformers
  • Advanced Audio Processing Libraries

📖 Documentation

For detailed documentation, please visit our API Documentation.

API Reference

The LumeCast API is built on Gradio and hosted on Hugging Face Spaces. Access the API and the deployment of the ML Model at:

https://huggingface.co/spaces/tmleyncodes/LumeCast

🔧 Configuration

Environment Variables

VITE_APP_TITLE=LumeCast
VITE_APP_DESCRIPTION=Transform Documents into Engaging Podcasts
VITE_GRADIO_URL=https://huggingface.co/spaces/tmleyncodes/LumeCast

🤝 Contributing

We welcome contributions! Please see our Contributing Guidelines for details.

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

📈 Performance Metrics

  • Average Processing Time: ~2 minutes per document
  • Supported File Formats: PDF [Working on the other formats as well]
  • Maximum File Size: 10MB
  • Supported Languages: 13+ languages

🔐 Security

LumeCast takes security seriously. We implement:

  • Secure file handling
  • API authentication
  • Data encryption
  • Regular security audits

📄 License

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

🙏 Acknowledgments

  • Hugging Face for hosting our model
  • Gradio for the backend framework
  • All our contributors and supporters
Built by team of LumeML