StudyForge - AI Study Content Generator

An AI-powered desktop app to generate study content from raw text using LLM integration.

---

🖥️ Running Locally (Development)

✅ Prerequisites

• Python 3.11+
• A Cohere API key
• Docker (optional, for containerised backend)
• Git
• Virtual environment set up (recommended)

---

⚙️ 1. Clone the repository

git clone https://github.com/berat-552/StudyForge.git
cd StudyForge

📦 2. Install dependencies

python -m venv .venv
call .venv\Scripts\activate
pip install -r requirements.txt

🔑 3. Set up environment variables

Create a .env file in the project root (you can copy from .env.example):

copy .env.example .env # command for cmd.exe

Then update the .env file with your Cohere API key:

COHERE_API_KEY=your-cohere-key-here
APP_ENV=dev
DEV_API_URL=http://127.0.0.1:8000
PROD_API_URL=https://studyforge-api.onrender.com

🚀 4. Start the app (Backend + GUI)

Use the batch script to launch everything:

run-dev-windows.bat # Windows

OR

run-dev-unix.sh # Unix

This will start the FastAPI backend in a new terminal window.

Then it will launch the GUI.

When you close the GUI, the backend will keep running in its terminal.

🐳 Running with Docker (Alternative Dev Option)

If you want to run the backend in a container:

🛠️ Build the Docker image

make docker-build

▶️ Run the container + launch GUI

make dev-docker

This runs the container in the background and launches the GUI.

When the GUI closes, the container is stopped automatically.

🛑 Manually Stop the Docker Container (if needed)

make docker-stop

🐳 Running with Docker Compose (Hot Reload Dev Setup)

If you want live-reloading of the backend while you develop:

Start backend (with hot reload) + launch GUI

make dev-full

This uses Docker Compose to start the backend with --reload, waits a few seconds, then launches the GUI app. The backend remains running after the GUI closes.

Make sure you have a .env file in your project root. You can copy it from .env.example if needed.

Stop the Docker Compose backend

make dev-full-down

---

🧪 Running Tests

make test

🧹 Format the Code

make format

Check out the Makefile for more commands.