Skip to content

pancacake/Academic-Support-System

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

6 Commits
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 
ย 

Repository files navigation

Academic Support System

Python Django License

An intelligent AI-powered academic support system that transforms learning materials into structured notes, mind maps, and practice questions. The Project is in progress. Feel free to follow FutureMind@BJTU

๐ŸŒŸ Overview

Academic Support System is a comprehensive AI-driven learning assistant built with Django. It leverages advanced AI technologies to help students and educators efficiently process academic materials, generate structured notes, create interactive mind maps, and generate practice questions.

โœจ Key Features

๐Ÿ“š Intelligent Document Processing

  • Multi-format Support: Handles PDF, Word (DOCX), and PowerPoint (PPTX) files
  • Advanced Parsing: Extracts text content and preserves document structure
  • Image Recognition: Processes embedded images and diagrams

๐Ÿค– AI-Powered Note Generation

  • Structured Notes: Automatically generates well-organized, hierarchical notes
  • Content Analysis: AI analyzes document content to identify key concepts
  • Smart Summarization: Creates concise summaries while maintaining academic rigor

๐Ÿง  Interactive Mind Mapping

  • Visual Learning: Converts notes into interactive mind maps
  • Hierarchical Structure: Organizes information in logical hierarchies
  • Export Options: Supports multiple export formats

๐Ÿ“ Intelligent Question Generation

  • Multiple Question Types: Generates various question formats
  • Difficulty Levels: Adapts question complexity based on content
  • Customizable: Allows users to specify preferences

๐Ÿ’ฌ Smart AI Assistant

  • Context-Aware Responses: AI understands document context
  • Chapter-Specific Q&A: Use @chapter_name syntax for targeted questions
  • Content Modification: Intelligent editing and enhancement

๐Ÿš€ Quick Start

Prerequisites

  • Python 3.8 or higher
  • pip package manager

Installation

  1. Clone Repository

    git clone https://github.com/yourusername/zhiwu-qiming-academic-system.git
    cd academic_support_system
  2. Create Virtual Environment

    python -m venv venv
    source venv/bin/activate  # On Windows: venv\Scripts\activate
  3. Install Dependencies

    pip install -r requirements.txt
  4. Configure API Keys

    cp academic_support_system/config_template.py academic_support_system/config.py
    # Edit config.py with your API keys
  5. Setup Database

    python manage.py migrate
  6. Run Application

    python manage.py runserver
  7. Access System

    • Open browser: http://localhost:8000
    • Use guest mode or create account

๐Ÿ“– Usage Guide

Basic Workflow

  1. Upload Documents: Upload PDF, DOCX, or PPTX files (max 5MB)
  2. Generate Notes: Type "็”Ÿๆˆ็ฌ”่ฎฐ" to create AI-generated notes
  3. Create Mind Maps: Click "ๆ€็ปดๅฏผๅ›พ" for visual representation
  4. Generate Questions: Visit "ๅ‡บ้ข˜" page for practice questions
  5. AI Q&A: Use @chapter_name for targeted questions

Advanced Features

Chapter-Specific Interactions

@Chapter_Name Your question here
Example: @Network_Basics What is TCP/IP protocol?

Content Modification

@Chapter_Name Modification request
Example: @Chapter_1 Please add more examples

๐Ÿ—๏ธ Architecture

Backend

  • Django 5.2+: Web framework with robust ORM
  • Django REST Framework: API development
  • Channels: WebSocket support

AI Integration

  • OpenAI API: GPT models for NLP
  • Custom Prompts: Optimized for academic content
  • Streaming Responses: Real-time generation

File Processing

  • PyMuPDF: PDF processing
  • python-docx: Word documents
  • python-pptx: PowerPoint files

๐Ÿ”ง Configuration

Environment Variables

API_KEY=your_openai_api_key
BASE_URL=https://api.openai.com/v1
DEFAULT_MODEL=your-model

File Settings

  • Formats: PDF, DOCX, PPTX
  • Max Size: 5MB
  • Storage: media/{user_id}/uploads/

๐Ÿงช Testing

# Run all tests
python test/test_runner.py

# Specific modules
python test/test_api_client.py
python test/test_note_generation.py

๐Ÿ“ Project Structure

academic_support_system/
โ”œโ”€โ”€ core/                    # Core functionality
โ”œโ”€โ”€ notes/                   # Note generation
โ”œโ”€โ”€ mindmap/                 # Mind map creation
โ”œโ”€โ”€ questions/               # Question generation
โ”œโ”€โ”€ users/                   # User management
โ”œโ”€โ”€ templates/               # HTML templates
โ”œโ”€โ”€ static/                  # Static files
โ”œโ”€โ”€ media/                   # User content
โ”œโ”€โ”€ test/                    # Test suite
โ”œโ”€โ”€ api_client.py            # AI API client
โ”œโ”€โ”€ config_template.py       # Configuration template
โ””โ”€โ”€ prompts.py               # AI prompts

๐Ÿค Contributing

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

๐Ÿ“„ License

MIT License - see LICENSE file for details.

About

Academic Support System is a comprehensive AI-driven learning assistant built with Django. It leverages advanced AI technologies to help students and educators efficiently process academic materials, generate structured notes, create interactive mind maps, and generate practice questions.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors