Skip to main content

Getting Started with Open TutorAI

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

🎥 Video Guide​

📺 Watch: EP1 – Step-by-step setup guide on YouTube

🛠️ 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

Happy exploring 🎉 If you have questions, join our community or raise an issue on GitHub.