AudioScholar is an intelligent, multi-user platform designed to record lecture audio and leverage AI-driven summarization techniques to produce structured insights for learners. As a dual-platform solution comprising an Android mobile application and a comprehensive web interface, it allows users to capture, summarize, and receive personalized learning material recommendations based on audio recordings. By transforming lengthy lectures into digestible key points, AudioScholar enhances note-taking efficiency and content comprehension.
- Smart Recording: Record lectures in real-time (online or offline) using the Android mobile app.
- Audio Uploads: Upload pre-recorded audio files from both mobile and web interfaces.
- Playback & Management: Centralized library with advanced playback controls and organizational tools.
- Intelligent Summarization: Leverages Google Gemini AI API to generate structured summaries, key topics, and glossaries.
- Contextual Enhancement: Upload PowerPoint presentations to augment AI processing for higher accuracy.
- Smart Recommendations: Automatically suggests relevant YouTube learning materials based on lecture content.
- Cross-Platform Access: Seamless experience across Android Mobile App and Web Interface.
- Cloud Synchronization: Securely sync recordings and summaries to Nhost Storage for access on any device.
- Offline Capabilities: Record and access local data on mobile even without an internet connection.
- Flexible Authentication: Secure login via Google, GitHub, or Email/Password using Firebase Authentication.
- User Notes: Integrated note-taking system to add personal insights alongside AI summaries.
- Freemium Architecture: Tiered feature access distinguishing between Free and Premium user experiences.
- Admin Dashboard: Powerful tools for user management, analytics, and system monitoring.
Ensure the following tools are installed on your system:
- Java Development Kit (JDK) 24
- Node.js (v16+)
- npm or yarn
- Git
- Maven (for backend)
- Android Studio (Latest version)
- Nhost Account (for cloud file storage - Nhost Cloud)
- Firebase Account (for authentication and Firestore database - Firebase Console)
git clone https://github.com/IT342-G3-AudioScholar/AudioScholar.git
cd AudioScholar-
Navigate to the backend:
cd backend/audioscholar -
Required Configuration Files: The backend requires two specific files to function correctly. You must create/place them in the specified locations:
.envfile: Required atbackend\audioscholar\.env- Firebase Service Account: Required at
backend\audioscholar\src\main\resources\firebase-service-account.json
-
Set up
.envcontent: Create the.envfile inbackend/audioscholar/with the following variables:# Nhost Storage Configuration NHOST_ADMIN_SECRET=your-nhost-admin-secret # Used by Spring Boot to access Nhost Storage # API Keys GEMINI_API_KEY=your-gemini-api-key YOUTUBE_API_KEY=your-youtube-api-key # Other secrets as needed # CONVERTAPI_SECRET=your-convertapi-secret # UPTIME_ROBOT_API=your-uptime-robot-api-key
-
Configure Application Properties: In
backend/audioscholar/src/main/resources/application.properties:- Ensure
nhost.storage.urlis correctly set. - Configure Firebase properties:
spring.cloud.gcp.project-id=your-firebase-project-id firebase.service-account.file=firebase-service-account.json
- Ensure
-
Run the backend:
mvn spring-boot:run
Or run
AudioscholarApplication.javafrom your IDE. (Spring Boot version3.5.8)
- Navigate to the web app:
cd frontend_web/audioscholar-app - Install dependencies:
npm install
- Create a
.envfile infrontend_web/audioscholar-app:# Backend API URL VITE_API_URL=http://localhost:8080 # Firebase Frontend Configuration VITE_FIREBASE_API_KEY=your-firebase-api-key VITE_FIREBASE_AUTH_DOMAIN=your-firebase-auth-domain VITE_FIREBASE_PROJECT_ID=your-firebase-project-id VITE_FIREBASE_STORAGE_BUCKET=your-firebase-storage-bucket VITE_FIREBASE_MESSAGING_SENDER_ID=your-firebase-messaging-sender-id VITE_FIREBASE_APP_ID=your-firebase-app-id
- Run the development server:
(Uses Vite
npm run dev
6.4.1, React19) Open at:http://localhost:3000
- Open Android Studio → "Open an Existing Project"
- Navigate to:
frontend_mobile/AudioScholar - Sync Gradle files.
- Configure Firebase:
- Place
google-services.jsoninfrontend_mobile/AudioScholar/app/.
- Place
- Configure API Base URL:
In
frontend_mobile/AudioScholar/local.properties:API_BASE_URL=http://your-local-network-ip:8080 - Run on an emulator or physical device.
- Register or log in using Firebase Authentication.
- Record a lecture using the mobile app. Audio is uploaded to Nhost Storage.
- AI processing generates summaries and metadata in Firebase Firestore.
- View the summary on web or mobile under My Lectures.
- Access recommended YouTube videos for deeper learning.
- Spring Boot 3.5.8
- Nhost Interaction
- Firebase Admin SDK
- Google Gemini AI API
- YouTube Data API v3
- React 19
- Vite 6.4.1
- Firebase SDK
- Kotlin + Jetpack Compose
- AndroidX
- Firebase SDKs
- Ktor Client
- Media3 ExoPlayer
The following features are explicitly noted as outside the scope of the initial AudioScholar release (v1.0):
| Feature | Status |
|---|---|
| Real-time Transcription | 🚫 Future enhancement |
| iOS Mobile Platform Support | 🚫 Android only for v1.0 |
| Web Interface Audio Recording | 🚫 Upload only for v1.0 |
| Multi-language Support | 🚫 English only for v1.0 |
| Background Recording (Free Users) | 🚫 Restricted feature |
| Recommendation Engine beyond YouTube | 🚫 Future enhancement |
- Use Case & Activity Diagrams: View on Figma
- Mobile Wireframes: View on Figma
- Web Wireframes: View on Figma
- Database Schema & ER Diagrams: View on Figma
Adviser/Lead:
- Ralph P. Laviste
Group Adviser:
- Jasmine A. Tulin
Proponents:
- Biacolo, Math Lee L.
- Terence, John Duterte
- Orlanes, John Nathan
- Barrientos, Claive Justin
- Alpez, Christian Brent
Distributed under the MIT License. See LICENSE for more information.
For issues, suggestions, or collaboration inquiries, feel free to open an issue or contact the development team.
✅ AudioScholar — Empowering learners through intelligent audio insights.