Skip to content

Desktop application for generating AI-powered educational case studies with support for OpenAI, Anthropic, Google Gemini, and local Ollama models

License

Notifications You must be signed in to change notification settings

michael-borck/critique-quest

Repository files navigation

CritiqueQuest

Every case, a new discovery

Desktop application for generating AI-powered educational case studies with support for OpenAI, Anthropic, Google Gemini, and local Ollama models.

Electron React TypeScript License

๐ŸŽฏ Overview

CritiqueQuest empowers educators and students to create high-quality, AI-generated case studies for educational purposes. Whether you're a lecturer developing engaging scenarios for your students or a student practicing critical thinking skills, CritiqueQuest transforms learning concepts into compelling case studies in minutes.

With support for both cloud-based AI services and local models through Ollama, it offers flexibility between convenience and complete privacy.

โœจ Key Features

  • ๐Ÿค– Multi-Provider AI Support - OpenAI GPT-4, Google Gemini, Anthropic Claude, and Ollama (local)
  • ๐Ÿ”’ Privacy-First Option - Run AI models locally with Ollama for complete data privacy
  • ๐Ÿ“š Local Content Library - Organize, search, and manage your case studies
  • ๐ŸŽฎ Practice Mode - Interactive self-assessment with timers and note-taking
  • ๐Ÿ“„ Multiple Export Formats - PDF, Word, HTML, and plain text
  • ๐ŸŽจ Intuitive Interface - Material-UI components with professional design
  • ๐Ÿ’พ Offline-First - Works without internet (with local AI models)

๐Ÿ‘ฅ Perfect For

๐Ÿ“š Educators & Lecturers

  • Create engaging case studies for any subject area
  • Generate scenarios with varying complexity levels
  • Export content for course materials and assignments
  • Build comprehensive case study libraries

๐ŸŽ“ Students & Learners

  • Practice critical thinking with AI-generated scenarios
  • Self-assess understanding through guided practice mode
  • Create study materials for exam preparation
  • Develop analytical skills across different domains

๐Ÿš€ Quick Start

Prerequisites

  • Node.js 18+ and npm
  • (Optional) Ollama for local AI models

Installation

# Clone the repository
git clone https://github.com/michael-borck/critiquequest.git
cd critiquequest

# Install dependencies
npm install

# Start development mode
npm run dev

First-Time Setup

  1. Launch the application
  2. Navigate to Settings โ†’ AI Configuration
  3. Choose your AI provider:
    • Cloud AI: Add API key for OpenAI/Google/Anthropic
    • Local AI: Install Ollama and pull a model (e.g., ollama pull llama2)
  4. Start generating case studies!

๐Ÿ“– Usage

Generating Case Studies

  1. Click Generate in the sidebar
  2. Configure your case study:
    • Domain: Business, Technology, Healthcare, Education, etc.
    • Complexity: Beginner, Intermediate, or Advanced
    • Scenario Type: Problem-solving, Decision-making, Ethical dilemmas
    • Context: Describe the scenario setting
  3. Click Generate Case Study
  4. Review and save the generated content

Managing Your Library

  • Search across all case studies
  • Filter by domain, complexity, or favorites
  • Tag content for better organization
  • Export in multiple formats for sharing or printing

Practice Mode

  1. Select a case study from your library
  2. Click Practice to start self-assessment
  3. Work through questions step-by-step
  4. Compare with AI-generated model answers
  5. Track your progress with session notes

๐Ÿ”ง Configuration

Using Cloud AI (OpenAI, etc.)

// Settings โ†’ AI Configuration
{
  "provider": "openai",
  "apiKey": "your-api-key-here",
  "model": "gpt-4"
}

Using Local AI (Ollama)

# Install Ollama
curl -fsSL https://ollama.ai/install.sh | sh

# Pull a model
ollama pull llama2

# Start Ollama service
ollama serve

# Configure in CritiqueQuest Settings

See OLLAMA_SETUP.md for detailed instructions.

๐Ÿ—๏ธ Architecture

critiquequest/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ main/           # Electron main process
โ”‚   โ”‚   โ”œโ”€โ”€ database.ts # Local JSON database
โ”‚   โ”‚   โ”œโ”€โ”€ ai-service.ts # AI provider integrations
โ”‚   โ”‚   โ””โ”€โ”€ file-service.ts # Export functionality
โ”‚   โ”œโ”€โ”€ renderer/       # React UI
โ”‚   โ”‚   โ”œโ”€โ”€ components/ # UI components
โ”‚   โ”‚   โ””โ”€โ”€ store/     # State management (Zustand)
โ”‚   โ””โ”€โ”€ shared/        # Shared types and utilities
โ”œโ”€โ”€ dist/              # Build output
โ””โ”€โ”€ release/          # Distribution packages

๐Ÿ› ๏ธ Development

Available Scripts

npm run dev          # Start development mode
npm run build        # Build for production
npm run dist         # Create distribution packages
npm run lint         # Run ESLint
npm run typecheck    # TypeScript type checking

Technology Stack

  • Frontend: React 18 + TypeScript + Material-UI
  • Backend: Electron + Node.js
  • State Management: Zustand
  • Database: JSON-based local storage
  • Build Tools: Vite + electron-builder

๐Ÿค Contributing

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

Development Guidelines

  • Follow TypeScript best practices
  • Maintain type safety throughout
  • Write clear commit messages
  • Update documentation as needed
  • Test with both cloud and local AI providers

๐Ÿ“ License

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

๐Ÿ™ Acknowledgments

๐Ÿ“ž Support


Transform learning concepts into engaging case studies in minutes! ๐Ÿš€

About

Desktop application for generating AI-powered educational case studies with support for OpenAI, Anthropic, Google Gemini, and local Ollama models

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages