Skip to content

Mahe077/study-aid

Repository files navigation

Study Aid 🎓

Flutter Firebase License: MIT

A cross-platform study companion application with advanced note-taking and voice recording capabilities, integrated with cloud synchronization.

Study Aid Demo

✨ Features

  • Multi-modal Note Taking

    • Rich text editor with Flutter Quill
    • Voice note recording & playback
    • Image embedding with Firebase Storage
    • Color-coded topic organization
  • Smart Sync System

    • Offline-first architecture with Hive
    • Conflict resolution for multi-device sync
    • Firebase Firestore backend
    • Automatic cloud backups
  • Authentication

    • Email/password login
    • Google & Facebook OAuth
    • Secure credential storage
    • Password recovery flow
  • Audio Processing

    • Waveform visualization
    • MP3 encoding/decoding
    • Background audio playback
    • File system management

🛠 Tech Stack

Core Framework

  • Flutter 3.16.9

State Management

  • Riverpod 2.3.6

Backend Services

  • Firebase Authentication
  • Cloud Firestore
  • Firebase Storage
  • Firebase App Check

Local Storage

  • Hive 2.2.3
  • Shared Preferences

Audio Processing

  • audio_waveforms 1.0.5
  • just_audio 0.9.41

Rich Text Editing

  • flutter_quill 10.8.2

🚀 Installation

  1. Clone Repository

    git clone https://github.com/yourusername/study_aid.git
    cd study_aid
  2. Flutter Setup

    flutter pub get
    flutter gen-l10n
  3. Firebase Configuration

    • Add google-services.json to android/app
    • Add GoogleService-Info.plist to iOS Runner
    • Enable Authentication/Firestore in Firebase Console
  4. Run Application

    flutter run -d chrome # For web
    flutter run # For mobile

📚 Documentation

🤝 Contributing

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📄 License

Distributed under the MIT License. See LICENSE for more information.

🙏 Acknowledgments

  • Flutter Community
  • Firebase Team
  • Hive Maintainers
  • Audio Waveforms Library Authors

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors