Skip to content

README.md

Latest commit

 

History

History
127 lines (94 loc) · 4.03 KB

README.md

File metadata and controls

127 lines (94 loc) · 4.03 KB

📚 Quzardry - Best for Students

Welcome to Quzardry, a smart, AI powered and lightweight study companion app designed for students.
It helps you learn faster and retain better with flashcards and quizzes.
Built with a clean UI and future-ready design, Quzardry is continuously improving to make studying more engaging and effective.

🚀 Features

  • 📝 Flashcards for quick revision
  • ❓ Quizzes to test your knowledge
  • 🎨 Simple & clean UI for distraction-free study
  • 📱 Mobile-friendly design built in Android Studio
  • ⚡ Lightweight, fast, and easy to use
  • 🤖 Geminis API integrated

📸 Screenshots

Home Flashcards Quiz
S 1 S 2 S 3

✨ Upcoming Features

  • 📊 Progress tracking & performance reports
  • 🔔 Study reminders & notifications
  • 🎯 Personalized quiz modes
  • 🎨 Improved UI/UX for a better experience
  • 📲 Generate Flashcards and Quizzes using AI

Installation ⬇️

You will need to download Git, JDK & Android Studio to run this project.

Git

  • Download and install Git from the official website: Git Downloads
  • Verify the installation: 
    git --version

JDK

  • Download and install JDK from the official website: JDK
  • Make sure you have the latest version of Git and JDK on your computer.
  • Verify the installation: 
    java -version

Android Studio

  • Download and install Android Studio from the official website: Android Studio

  • Make sure you have the latest version of Git on your computer.

Getting Started 🎯

Fork and Clone the Repository 🚀

  1. Click the Fork button at the top-right corner of the page to create your own copy of the repository.
  2. After forking, open your terminal and run the following commands to clone the repo:
git clone https://github.com/muhammadsufyanzafar/Quzardry-A-FlashCard-App.git

Navigate to the Project Directory 📂 Once the repository is cloned, change your directory to the project folder:

cd Quzardry

Install Dependencies ⚙️ From the root directory of your project, install the necessary packages:

npm install

3. Open in Android Studio

  • Open Android Studio.
  • Click on "Open an Existing Project".
  • Navigate to the folder where you cloned/extracted the project.
  • Select the project root folder and open it.

4. Sync Gradle

  • Once the project opens, Android Studio will automatically sync Gradle.
  • If it doesn’t, click on File → Sync Project with Gradle Files.

5. Set SDK Version (if needed)

  • Go to File → Project Structure → SDK Location.
  • Make sure the Android SDK path is correctly set.
  • Ensure the project is using the right Gradle & JDK versions.

6. Build the Project

  • Click on Build → Make Project (or press Ctrl+F9 / Cmd+F9).

7. Run the App

  • Connect a physical device via USB (with USB Debugging enabled) OR
  • Use an Android Emulator (create one in AVD Manager).
  • Click the green ▶️ Run button in Android Studio.

🚀 Troubleshooting

  • Gradle Sync Failed → Check your internet connection, update Gradle, or delete .gradle folder and resync.
  • SDK not found → Make sure Android SDK is installed via SDK Manager.
  • Emulator issues → Enable virtualization in BIOS, or try a physical device.

🤝 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

This project is open-source and free to use under the MIT License.

Designed and developed with ❤️ by Muhammad Sufyan Zafar