Open SourceDocumentation
Complete setup and usage guide for NeuroBridgeEDU Open Source Edition. Real-time AI-powered transcription and summarization with privacy-first design and professional-grade features for everyone.
Core Features
Professional-grade transcription and summarization with complete privacy control and bring-your-own-API-key architecture.
Professional Audio Recording
Real-time microphone capture with advanced audio processing
Whisper Transcription
Cloud-based speech-to-text with hallucination filtering
AI Summarization
LLM-powered content analysis and structuring
Multiple Export Formats
Download as PDF or Markdown files with professional formatting
Privacy-First Design
No data collection, stateless processing, local control
Real-time Processing
Sub-second audio processing with live transcription updates
Quick Start Guide
Get NeuroBridgeEDU Open Source Edition running in minutes with this step-by-step setup guide.
Prerequisites
Ensure you have the required software and accounts
- Node.js 20+ and Python 3.11+
- OpenAI API Key (get one at platform.openai.com)
- Modern browser with microphone access
Clone & Setup
Get the source code and configure environment
git clone <repository-url> cd NeuroBridge-OpenSource cp .env.example .env
Install Dependencies
Install both frontend and backend requirements
# Install frontend dependencies npm install # Install backend dependencies cd python_backend pip install -r requirements.txt cd ..
Start Application
Launch both backend and frontend servers
# Terminal 1: Start Python backend (FastAPI) cd python_backend python -m uvicorn main:app --host 0.0.0.0 --port 3939 --reload # Terminal 2: Start React frontend (Vite) npm run dev:frontend
Usage Workflow
Simple 4-step process from recording to export with professional results and complete privacy control.
Configure API Key
Add your OpenAI API key (encrypted storage) via Settings
Start Recording
Click record button and begin speaking for real-time transcription
Generate Summary
Click 'Generate Summary' for AI-powered content analysis
Edit & Export
Edit the summary and download as PDF or Markdown
Technology Stack
Modern, privacy-first architecture with professional-grade audio processing and secure API key management.
Frontend
- React 18 with TypeScript
- Vite 7.0 build tool
- Tailwind CSS 3.3
- Zustand state management
- Radix UI components
Backend
- Python 3.11+ with FastAPI
- SQLAlchemy 2.0 with SQLite
- AES-256-GCM encryption
- Server-Sent Events
- OpenAI API integration
AI & Processing
- OpenAI Whisper API (whisper-1)
- Advanced LLM for summarization
- Custom audio processing
- Smart hallucination filtering
Enterprise-Grade Security
Your privacy is guaranteed with military-grade encryption and local-only storage.
AES-256-GCM Encryption
- API keys encrypted before storage
- Unique nonce prevents replay attacks
- HKDF key derivation function
Local-Only Storage
- Keys stored in ~/.neurobridge/ directory
- File permissions 0600 (owner-only access)
- Zero data collection or sharing
Your Privacy Guarantee
NeuroBridge developers never have access to your API keys or transcription data. Everything is processed locally or directly with OpenAI using your credentials.
Cost Transparency
90% cost reduction with local processing. Only pay OpenAI for summarization - transcription is completely free!
Transcription
per minute of audio
Summarization
per summary
1-Hour Example
total cost
Typical Monthly Usage Costs
Getting Help & Contributing
Join our community of developers and users building privacy-focused transcription tools for everyone.
Community Support
- Check GitHub Issues for similar problems
- Review technical implementation details
- Join discussions and troubleshooting
Contributing Areas
- Audio processing and AI features
- Mobile support and PWA features
- Documentation and tutorials
Built with ❤️ for privacy, accessibility, and open source innovation