Installation Guide

Installation Guide

Requirements

• Python 3.10 or later
• pip and a code editor such as VS Code
• A free Groq API key from console.groq.com
• Internet connection (needed for Groq API calls)

Step 1: Extract the Project

Unzip the downloaded folder and open a terminal inside the project root, where manage.py is located.

Step 2: Create and Activate a Virtual Environment

python -m venv venv

Windows: venv\Scripts\activate

macOS / Linux: source venv/bin/activate

Step 3: Install Dependencies

pip install -r requirements.txt

Step 4: Configure the Groq API Key

Create a file named .env in the project root and add this line:

GROQ_API_KEY=your_groq_api_key_here

Step 5: Set Up the Database

python manage.py migrate

python manage.py createsuperuser

Step 6: Run the Server

python manage.py runserver

Open http://127.0.0.1:8000/ in your browser, register an account, upload a syllabus PDF and generate your first study plan.

Troubleshooting

• Authentication error from Groq: check that the key in .env has no extra spaces or quotes.
• No topics extracted: the PDF is probably a scanned image. Try a text-based PDF.
• Rate limit message: wait a minute and retry. The free tier has a per-minute request cap.

Prefer not to deal with setup? Add the Project Setup service and we will install it for you over a live session.