Skip to content

Latest commit

 

History

History
86 lines (60 loc) · 2.64 KB

File metadata and controls

86 lines (60 loc) · 2.64 KB

📚 StudyFlash

🚀 About

StudyFlash is an Android application built with Jetpack Compose that helps students create, manage, and study flashcards with ease.
It’s designed to make learning interactive and effective by combining categories, progress tracking, and simple UI/UX for a smooth study experience.

This project was created as part of the Android Development track @ DEPI.


✨ Features

  • 📌 Category-based organization → Group your flashcards by topics.
  • 📝 Add / Edit flashcards easily.
  • 📊 Track progress with visual statistics.
  • 🎨 Modern UI built entirely with Jetpack Compose.
  • 🔒 Firebase Authentication for secure login & signup.
  • ☁️ Cloud Sync → Your flashcards are stored safely online.

🛠️ Tech Stack

  • Language: Kotlin
  • UI: Jetpack Compose
  • Architecture: MVVM + Hilt for dependency injection
  • Database & Backend: Firebase (Firestore, Authentication)
  • Charts & Visualization: Android libraries for bar/pie charts

📸 Some Screenshots


📂 Project Structure

StudyFlash/
 ├── app/                     # Main Android app module  
 │   ├── data/                # Repository, models, Firebase integration  
 │   ├── ui/                  # Compose UI components and screens  
 │   ├── viewmodel/           # MVVM ViewModels  
 │   └── di/                  # Hilt Dependency Injection  
 └── ...

🚦 Getting Started

1️⃣ Clone the repo

git clone https://github.com/Andriod-DEPI/StudyFlash.git

2️⃣ Open in Android Studio

  • Use Android Studio Giraffe+.
  • Make sure you have Kotlin + Compose support enabled.

3️⃣ Setup Firebase

  • Add your google-services.json inside the app/ folder.
  • Enable Authentication + Firestore from Firebase Console.

4️⃣ Run the App 🚀


🤝 Contribution

Contributions are welcome! 💡
If you’d like to fix bugs, add features, or improve documentation:

  1. Fork the repo
  2. Create a new branch (feature/my-update)
  3. Commit your changes
  4. Open a Pull Request