ragtim-bot / README.md
raktimhugging's picture
Update README.md
1c69645 verified
|
raw
history blame
6.86 kB

πŸ€– Raktim Mondol's Portfolio with RAGtim Bot

A modern, responsive portfolio website featuring an intelligent AI assistant powered by multiple backend options including Hugging Face Transformers.

🌟 Features

Portfolio Website

  • Responsive Design: Beautiful, mobile-first design with dark/light theme support
  • Interactive Sections: Education, Experience, Skills, Research, Publications, Awards
  • Audio Summaries: Listen to AI-generated summaries of research papers
  • Thesis Mind Map: Interactive visualization of PhD research (desktop only)
  • Contact Form: Direct email integration with validation

RAGtim Bot - AI Assistant

  • Multiple Backend Options: Choose from Hugging Face Space, Backend Server, or Netlify Functions
  • Advanced Search: Hybrid semantic + keyword search for accurate responses
  • Comprehensive Knowledge: Covers all aspects of Raktim's expertise
  • Real-time Chat: Instant responses with conversation history
  • Performance Optimized: Caching and efficient processing

πŸš€ RAGtim Bot Deployment Options

Option 1: Hugging Face Space (Recommended) πŸ€—

Pros: Free GPU acceleration, no API keys needed, automatic scaling Best for: Public deployment, maximum performance

# Set environment variable
VITE_USE_HUGGING_FACE=true

Live Demo: RAGtim Bot on Hugging Face

Option 2: Backend Server πŸ–₯️

Pros: Full control, local processing, custom configurations Best for: Development, private deployments

# Set environment variables
VITE_USE_BACKEND=true
VITE_BACKEND_URL=http://localhost:3001
VITE_DEEPSEEK_API_KEY=your_api_key

# Start backend server
cd server
npm install
npm run dev

# Start frontend
npm run dev

Option 3: Netlify Functions ⚑

Pros: Serverless, automatic scaling, integrated with Netlify Best for: Simple deployments, cost-effective

# Set environment variable
VITE_DEEPSEEK_API_KEY=your_api_key
# (VITE_USE_HUGGING_FACE and VITE_USE_BACKEND should be false or unset)

πŸ› οΈ Quick Start

1. Clone and Install

git clone <repository-url>
cd portfolio
npm install

2. Choose Your RAG Backend

For Hugging Face Space (Easiest):

echo "VITE_USE_HUGGING_FACE=true" > .env
npm run dev

For Backend Server:

echo "VITE_USE_BACKEND=true" > .env
echo "VITE_BACKEND_URL=http://localhost:3001" >> .env
echo "VITE_DEEPSEEK_API_KEY=your_api_key" >> .env

# Start both frontend and backend
npm run dev:full

For Netlify Functions:

echo "VITE_DEEPSEEK_API_KEY=your_api_key" > .env
npm run dev

3. Open Browser

Visit http://localhost:5173 to see the portfolio with RAGtim Bot!

πŸ“Š RAGtim Bot Comparison

Feature Hugging Face Backend Server Netlify Functions
Setup Complexity ⭐ Easy ⭐⭐⭐ Complex ⭐⭐ Medium
Performance ⭐⭐⭐ Excellent ⭐⭐⭐ Excellent ⭐⭐ Good
Cost πŸ†“ Free πŸ’° Server costs πŸ’° Function costs
Scalability ⭐⭐⭐ Auto ⭐⭐ Manual ⭐⭐⭐ Auto
Customization ⭐⭐ Limited ⭐⭐⭐ Full ⭐⭐ Medium
API Key Required ❌ No βœ… Yes βœ… Yes

🎯 RAGtim Bot Capabilities

What You Can Ask:

  • Research: "What is Raktim's research about?"
  • Publications: "Tell me about BioFusionNet"
  • Skills: "What programming languages does he know?"
  • Experience: "Where has he worked?"
  • Education: "What degrees does he have?"
  • Statistics: "What statistical methods does he use?"
  • Contact: "How can I reach Raktim?"

Technical Features:

  • Semantic Search: Understanding context and meaning
  • Keyword Matching: Exact term matching for precision
  • Conversation Memory: Maintains chat history
  • Response Caching: Fast repeated queries
  • Error Handling: Graceful fallbacks and error messages

πŸ”§ Development

Frontend Development

npm run dev          # Start development server
npm run build        # Build for production
npm run preview      # Preview production build

Backend Development (if using backend server)

cd server
npm run dev          # Start backend in development
npm run start        # Start backend in production
npm run install-models  # Pre-download AI models

Full Stack Development

npm run dev:full     # Start both frontend and backend
npm run build:full   # Build both frontend and backend

πŸš€ Deployment

Deploy to Netlify (with Hugging Face)

  1. Set VITE_USE_HUGGING_FACE=true in Netlify environment variables
  2. Deploy normally - no additional configuration needed!

Deploy to Netlify (with Functions)

  1. Set VITE_DEEPSEEK_API_KEY in Netlify environment variables
  2. Netlify Functions will be automatically deployed

Deploy Backend Server

Choose from:

  • Railway: Easy deployment with automatic scaling
  • Render: Free tier available, good for development
  • DigitalOcean: Full control, various pricing options
  • AWS/GCP: Enterprise-grade with advanced features

πŸ“± Mobile Experience

  • Responsive Design: Optimized for all screen sizes
  • Touch-Friendly: Large buttons and easy navigation
  • Fast Loading: Optimized assets and lazy loading
  • Offline Fallback: Graceful degradation when offline

🎨 Customization

Themes

  • Light and dark mode support
  • Consistent color scheme throughout
  • Smooth transitions and animations

Content

  • Easy content updates via markdown files
  • Modular component structure
  • Configurable sections and features

πŸ”’ Security & Privacy

  • No Data Storage: Conversations are not stored permanently
  • Secure APIs: All API calls use HTTPS
  • Input Validation: Prevents malicious inputs
  • Rate Limiting: Prevents abuse and spam

πŸ“ˆ Performance

  • Lighthouse Score: 95+ across all metrics
  • Fast Loading: Optimized bundle sizes
  • Efficient Caching: Smart caching strategies
  • CDN Ready: Optimized for global delivery

🀝 Contributing

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Test thoroughly
  5. Submit a pull request

πŸ“„ License

MIT License - see LICENSE file for details

πŸ™ Acknowledgments

  • Hugging Face: For providing free GPU-accelerated AI hosting
  • OpenAI/DeepSeek: For powerful language models
  • Netlify: For seamless deployment and functions
  • React/Vite: For the excellent development experience
  • Tailwind CSS: For beautiful, responsive styling

Live Demo: mondol.me RAGtim Bot: Hugging Face Space

Built with ❀️ by Raktim Mondol