Skip to content

sidtum/SpeakLink

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 

Repository files navigation

SpeakLink

A comprehensive solution designed to bridge the language gap between schools and non-English speaking parents, enabling better understanding of student progress and parent-teacher communication.

Check out our demo: https://youtu.be/KTO2y-lEk9I

🌟 Features

1. Student Information Understanding

  • Document Upload & Analysis: Parents can upload student transcripts and report cards
  • Multilingual Q&A: Ask questions about student performance in your native language
  • RAG-based System: Advanced retrieval-augmented generation for accurate information processing
  • Real-time Translation: Seamless translation of educational documents and queries

2. Parent-Teacher Conference Support

  • Real-time Recording: Capture parent-teacher conferences
  • Automatic Transcription: Convert speech to text in real-time
  • Multilingual Summaries: Get comprehensive meeting summaries in your preferred language
  • Progress Tracking: Maintain a history of all conferences and feedback

🛠️ Technical Stack

Backend

  • Framework: FastAPI & Flask
  • AI/ML: OpenAI API, LangChain
  • Database: ChromaDB for document storage
  • Audio Processing: SpeechRecognition, pydub
  • OCR: pytesseract for document text extraction
  • Translation: deep-translator

Frontend

  • Framework: React with TypeScript
  • UI Components: Modern, responsive design
  • State Management: Efficient data handling
  • Real-time Updates: WebSocket integration for live features

🚀 Getting Started

Prerequisites

  • Python 3.8+
  • Node.js 16+
  • OpenAI API key
  • Virtual environment (recommended)

Installation

  1. Clone the repository
git clone https://github.com/sidtum/SpeakLink.git
cd SpeakLink
  1. Backend Setup
cd backend
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate
pip install -r requirements.txt
  1. Frontend Setup
cd frontend
npm install
  1. Environment Configuration
  • Create a .env file in the backend directory with:
OPENAI_API_KEY=your_api_key

Running the Application

  1. Start the Backend
cd backend
python server.py
  1. Start the Frontend
cd frontend
npm start

📁 Project Structure

.
├── backend/
│   ├── services/        # Core business logic
│   ├── routes/          # API endpoints
│   ├── recordings/      # Conference recordings
│   ├── uploads/         # Document uploads
│   ├── chroma_db/       # Vector database
│   └── server.py        # Main application file
├── frontend/
│   ├── src/            # React components
│   ├── public/         # Static assets
│   └── package.json    # Frontend dependencies
└── requirements.txt    # Python dependencies

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors