Skip to content

AI-powered FAQ Bot SaaS Platform for Educational Institutions

License

visualGravitySense/faq-bot-saas

Repository files navigation

πŸ€– FAQ Bot SaaS - AI-Powered Educational Support Platform

License: MIT Python 3.10+ React 19 FastAPI TypeScript

Transform your educational institution's support with intelligent chatbots! Create, deploy, and manage AI-powered FAQ bots for multiple channels including Telegram, WhatsApp, and web widgets.

✨ Features

🧠 AI-Powered Intelligence

  • Advanced semantic search using Sentence Transformers
  • Context-aware responses to student questions
  • Multi-language support (Russian, English, Estonian)
  • Confidence scoring for response quality

πŸ“± Multi-Channel Deployment

  • Telegram Bot Integration - Deploy bots directly to Telegram
  • Web Widget - Embed in your website
  • WhatsApp Integration - Coming soon
  • API Access - Integrate with any platform

πŸ“Š Comprehensive Analytics

  • Real-time bot performance metrics
  • User interaction tracking
  • Query analysis and insights
  • Revenue and usage statistics

🎯 SaaS-Ready Features

  • User authentication and authorization
  • Subscription management
  • Payment integration (Stripe)
  • Multi-tenant architecture
  • Admin dashboard

πŸš€ Quick Start

Prerequisites

  • Node.js 18+ and npm
  • Python 3.10+
  • Git

Installation

  1. Clone the repository

    git clone https://github.com/yourusername/faq-bot-saas.git
    cd faq-bot-saas
  2. Backend Setup

    cd backend
    pip install -r requirements.txt
    cp env_example.txt .env
    # Edit .env with your configuration
    python run.py
  3. Frontend Setup

    cd frontend
    npm install
    npm run dev
  4. Access the application

πŸ—οΈ Architecture

faq-bot-saas/
β”œβ”€β”€ backend/                 # FastAPI backend
β”‚   β”œβ”€β”€ app/
β”‚   β”‚   β”œβ”€β”€ api/            # API endpoints
β”‚   β”‚   β”œβ”€β”€ core/           # Configuration
β”‚   β”‚   β”œβ”€β”€ services/       # Business logic
β”‚   β”‚   └── models/         # Data models
β”‚   β”œβ”€β”€ requirements.txt    # Python dependencies
β”‚   └── run.py             # Application entry point
β”œβ”€β”€ frontend/               # React frontend
β”‚   β”œβ”€β”€ src/
β”‚   β”‚   β”œβ”€β”€ components/     # React components
β”‚   β”‚   β”œβ”€β”€ pages/          # Page components
β”‚   β”‚   β”œβ”€β”€ services/       # API services
β”‚   β”‚   └── contexts/       # React contexts
β”‚   β”œβ”€β”€ package.json        # Node dependencies
β”‚   └── vite.config.ts      # Vite configuration
└── docs/                   # Documentation

πŸ’° Monetization

Pricing Plans

Plan Price Features
Starter €29/month 1 bot, 1,000 queries, Basic analytics
Professional €99/month 5 bots, 10,000 queries, Advanced analytics
Business €299/month Unlimited bots, 50,000 queries, Full features

Revenue Streams

  1. Subscription Revenue - Monthly/yearly plans
  2. Usage-Based Pricing - Pay per query
  3. Enterprise Licenses - Custom solutions
  4. White-Label Solutions - Reseller opportunities

πŸ”§ Configuration

Environment Variables

Create a .env file in the backend directory:

# API Configuration
API_V1_STR=/api/v1
PROJECT_NAME=FAQ Bot SaaS

# Database
DATABASE_URL=sqlite:///./faq_bot_saas.db

# JWT Authentication
SECRET_KEY=your-secret-key-here
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=30

# Telegram Bot
TELEGRAM_BOT_TOKEN=your-telegram-bot-token

# Stripe Payments
STRIPE_SECRET_KEY=your-stripe-secret-key
STRIPE_PUBLISHABLE_KEY=your-stripe-publishable-key

# OpenAI (Optional)
OPENAI_API_KEY=your-openai-api-key

Telegram Bot Setup

  1. Create a bot with @BotFather
  2. Get your bot token
  3. Add it to your .env file
  4. Start the Telegram service

πŸ“š Documentation

πŸ› οΈ Development

Running in Development

# Backend (Terminal 1)
cd backend
python run.py

# Frontend (Terminal 2)
cd frontend
npm run dev

# Telegram Bot (Terminal 3)
cd backend
python run_telegram_bot.py

Testing

# Backend tests
cd backend
pytest

# Frontend tests
cd frontend
npm test

πŸš€ Deployment

Docker Deployment

# Build and run with Docker Compose
docker-compose up -d

Cloud Deployment

  • Heroku - One-click deployment
  • AWS - EC2, ECS, or Lambda
  • DigitalOcean - Droplet or App Platform
  • Google Cloud - Cloud Run or GKE

🀝 Contributing

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

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

πŸ“„ License

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

🎯 Roadmap

Q1 2024

  • WhatsApp integration
  • Advanced analytics dashboard
  • Mobile app (React Native)
  • Multi-language UI

Q2 2024

  • Voice message support
  • Advanced AI training
  • Enterprise features
  • API rate limiting

Q3 2024

  • White-label solutions
  • Advanced integrations
  • Machine learning insights
  • Global deployment

πŸ’‘ Business Opportunities

For Entrepreneurs

  • SaaS Business - Start your own FAQ bot service
  • White-Label - Resell to educational institutions
  • Consulting - Help organizations implement AI chatbots

For Developers

  • Open Source - Contribute to the project
  • Extensions - Build custom integrations
  • Plugins - Create additional features

For Educational Institutions

  • Student Support - Improve student experience
  • Cost Reduction - Reduce support staff workload
  • 24/7 Availability - Always-on support

πŸ“ž Support

🌟 Star History

Star History Chart


Made with ❀️ for the educational community

Transform education with AI-powered support. Start your FAQ Bot SaaS journey today!

About

AI-powered FAQ Bot SaaS Platform for Educational Institutions

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published