Open TutorAI 👋

OpenTutorAI-CE (Community Edition) is an open-source project designed to provide an educational and collaborative AI-powered platform. This public edition is the foundation for a proprietary Enterprise Edition (EE) and is built to encourage community contributions.

[!TIP]

Looking for a Support? – Speak with our support Team Today!

Get enhanced capabilities, including custom theming and branding, Service Level Agreement (SLA) support, Long-Term Support (LTS) versions, and more!

For more information, be sure to check out our Open TutorAI Documentation.

⭐ Key Features of Open TutorAI

Open TutorAI-CE is packed with powerful features designed for educational and collaborative AI experiences. Here’s what makes it stand out:

• 🚀 Effortless Setup with Docker
  Set up your environment in minutes using Docker with support for :ollama and :cuda tagged images, ensuring a streamlined and hassle-free deployment.

• 🤖 Ollama & OpenAI API Compatibility
  Easily integrate OpenAI-compatible APIs for flexible conversations. Customize the API endpoint to connect with services like LMStudio, GroqCloud, Mistral, OpenRouter, and more—alongside local Ollama models.

• 🛡️ Granular Permissions & User Groups
  Admins can define detailed roles and permissions, allowing for secure, customized user experiences while promoting accountability and collaboration.

• 🧑‍💻 Responsive & Mobile-Optimized Design
  Enjoy a smooth user experience across desktops, laptops, and mobile devices with a fully responsive interface.

• 📱 Progressive Web App (PWA) Support
  Install Open TutorAI on your mobile device for an app-like experience, including offline mode on localhost and full access to core functionality.

• 🎤📹 Voice, Video & Avatar Discussion Mode
  Interact hands-free using integrated voice and video calls, or dive into an engaging experience with our avatar-powered discussion mode—a lifelike conversational interface that brings your AI to life.

• 🧑‍🏫 Personalized Learning Experience
  Open TutorAI is purpose-built for education:

  • 🎓 Customize learning support to meet individual learner needs.
  • 🧠 Generate a personalized LLM, optionally paired with a user-selected avatar, tailored to each learner's style, personality, or curriculum.

• 🛠️ Model Builder: Easily create Ollama models. Create and add custom characters/agents, customize chat elements, and import models effortlessly.

• 📚 Local RAG Integration for Educational Content
  Empower learners and educators with Retrieval-Augmented Generation (RAG) tailored for education. Seamlessly integrate textbooks, lecture notes, assignments, and research papers into the chat experience. Students can load documents directly into the conversation or access classroom resources from their document library using the # command—enabling context-aware tutoring, assignment help, and in-depth discussion of study material.

• 🔍 Educational Web Search for RAG
  Enhance learning with real-time web search integration. Students and educators can perform targeted research using providers like Google PSE, SearXNG, Brave, DuckDuckGo, and more—right from the chat. The search results are automatically injected into the conversation, enabling fact-checking, discovery of up-to-date information, and exploration of external academic resources without leaving the tutoring environment.

• 🌐 Web Browsing Capability: Seamlessly integrate websites into your chat experience using the # command followed by a URL. This feature allows you to incorporate web content directly into your conversations, enhancing the richness and depth of your interactions.

• 🎨 Image Generation Integration: Seamlessly incorporate image generation capabilities using options such as AUTOMATIC1111 API or ComfyUI (local), and OpenAI's DALL-E (external), enriching your chat experience with dynamic visual content.

• ⚙️ Many Models Conversations: Effortlessly engage with various models simultaneously, harnessing their unique strengths for optimal responses. Enhance your experience by leveraging a diverse set of models in parallel.

• 🔐 Role-Based Access Control (RBAC): Ensure secure access with restricted permissions; only authorized individuals can access your Ollama, and exclusive model creation/pulling rights are reserved for administrators.

• 🌐🌍 Multilingual Support: Experience Open TutorAI in your preferred language with our internationalization (i18n) support. Join us in expanding our supported languages! We're actively seeking contributors!

• 🌟 Continuous Updates: We are committed to improving Open TutorAI with regular updates, fixes, and new features.

Want to learn more about Open TutorAI's features? Check out our Open TutorAI documentation for a comprehensive overview!

🔗 Also Check Out Open TutorAI Community!

Don't forget to explore our sibling project, Open TutorAI Community, where you can discover, download, and explore customized Modelfiles. Open TutorAI Community offers a wide range of exciting possibilities for enhancing your chat interactions with Open TutorAI! 🚀

How to Install 🚀

Below is a list of essential steps and resources to help you get started, manage, and develop with Open TutorAI.

🛠️ Setup Guide

Follow these steps to set up the project locally:

1. Fork and Clone the Repository

   • Go to GitHub Repository
   • Click on Fork, then clone your forked repo:

     git clone https://github.com/YOUR_USERNAME/open-tutor-ai-CE.git
     cd open-tutor-ai-CE

2. Backend Setup

   • Navigate to the backend folder:

     cd backend

   • Create and activate a new Conda environment:

     conda create -n tutorai-env python=3.11
     conda activate tutorai-env

   • Install the required packages:

     pip install -r requirements.txt

   • For development:

     ./dev.sh

   • Or for production:

     ./start.sh

3. Frontend Setup

   • From the root of the project (or navigate to the frontend folder):

     npm install
     npm run dev

---

Troubleshooting

Encountering connection issues? Our Open TutorAI Documentation has got you covered. For further assistance and to join our vibrant community, visit the Open TutorAI Discord.

🌟 What's Next?

Discover upcoming features on our roadmap in the Open TutorAI Documentation.

📜 License

This project is licensed under the BSD-3-Clause License - see the LICENSE file for details. 📄

💬 Support

If you have any questions, suggestions, or need assistance, please open an issue or join our Open TutorAI Discord community to connect with us! 🤝

Star History

---

Created by El Hajji - Let's make Open TutorAI even more amazing together! 💪