dfeverx/learning-partner

Elevate your learning experience with Ninaiva, the ultimate AI Learning Partner. Whether you're a student, professional, or lifelong learner, Ninaiva transforms your notes and study materials into powerful learning tools. #BuildWithGemini

Ninaiva : Learning Partner

Ninaiva is your AI-powered learning companion, designed to transform the way you study. By converting your notes into key points, flashcards, and quizzes, Ninaiva ensures you retain knowledge efficiently through features like spaced repetition and detailed explanations.

---

✨ Features

• Scan & Convert: Transform your notes into key points, flashcards, and quizzes with ease.
• Spaced Repetition: Master subjects using memory-enhancing techniques.
• Engagement streak: Maintain learning streaks for consistent study habits.
• In-Depth Explanations: Access detailed explanations for complex concepts.
• Progress Tracking: Visualize your learning journey and achievements.

---

🛠️ Technology Stack

Android Application: learning-partner-android

• Language: Kotlin
• UI: Jetpack Compose, Material M3
• Architecture: MVVM (Model-View-ViewModel)
• Dependency Injection: Hilt
• Database: Room
• Authentication: Firebase Auth (Anonymous, Google)
• Cloud Storage: Firestore
• Analytics & Remote Config: Firebase Analytics, RemoteConfig

Backend Functions: learning-partner-firebase-functions

• Language: TypeScript
• Backend Framework: Firebase Cloud Functions
• AI Integration: Genkit

---

🚀 Getting Started

Prerequisites

To run Ninaiva locally, you'll need:

• Android Studio (latest version recommended)
• Firebase Account for backend services
• Node.js and npm for Firebase Cloud Functions

Installation

1. Clone the Repository:

   git clone https://github.com/dfeverx/learning-partner.git
   cd learning-partner

2. Setup Android Project:

   Navigate to the learning-partner-android directory, open it in Android Studio, and sync the project.

3. Setup Firebase Functions:

   Navigate to the learning-partner-firebase-functions directory, install dependencies, and deploy functions:

   cd learning-partner-firebase-functions
   npm install
   firebase deploy

4. Run the App:

   In Android Studio, run the app on a connected device or emulator.

---

🌍 Contributing

We welcome contributions! Here's how you can get involved:

1. Fork the Repo: Fork the repository.
2. Create a Branch: Use git checkout -b feature-branch-name for your feature or bugfix.
3. Commit Your Changes: Use clear and descriptive commit messages.
4. Submit a Pull Request: Push your changes to your fork and open a pull request to the main branch.

---

💬 Community & Support

• Report Issues: Use the GitHub Issues tab to report bugs or request features.
• Contact Us: Reach out at [email protected] for queries.

---

📄 License

Ninaiva is released under the MIT License. You're free to use, modify, and distribute the code under the terms of the license.

---

🌟 Acknowledgments

Special thanks to the open-source community and our beta testers for their invaluable feedback. Your contributions have helped make Ninaiva what it is today.

---

Stay curious, keep learning, and let Ninaiva guide your educational journey!

---