Skip to content

Latest commit

 

History

History
115 lines (84 loc) · 6.6 KB

README.md

File metadata and controls

115 lines (84 loc) · 6.6 KB
Raw

QuizZon

QuizZon is an app to create and play quizzes

Application Install

You can Install QuizZon app from playstore 👇

QuizZon

Setup

Clone the repository on your machine. Open the project on your IDE and connect it to firebase and harperDB and everything will be setup

  • Add your firebase json class in app directory
  • Add your Harperdb Credentital in build.property

About

It uses firebase and HarperDB as it's backend. It uses Firebase Authentication for email based auth, Firebase Crashlytics for crash reporting and HarperDB as its database.

  • Fully functionable.
  • Clean and Simple Material UI.

Insights into the app 🔎

QuizZon.gif

📸 Screenshots

Built With 🛠

  • Kotlin - First class and official programming language for Android development.
  • Coroutines - For asynchronous and more..
  • Flow - A cold asynchronous data stream that sequentially emits values and completes normally or with an exception.
  • StateFlow - StateFlow is a state-holder observable flow that emits the current and new state updates to its collectors.
  • Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
    • ViewModel - Stores UI-related data that isn't destroyed on UI changes.
    • ViewBinding - Generates a binding class for each XML layout file present in that module and allows you to more easily write code that interacts with views.
    • DataStore - Jetpack DataStore is a data storage solution that allows you to store key-value pairs or typed objects with protocol buffers.
  • Dependency Injection -
    • Hilt-Dagger - Standard library to incorporate Dagger dependency injection into an Android application.
    • Hilt-ViewModel - DI for injecting ViewModel.
  • Backend
    • Firebase
      • Firebase Auth - To support email based authentication and google authentication
      • Firebase Crashlytics - To report app crashes
    • HarperDB - HarperDB is a geo-distributed database with hybrid SQL & NoSQL functionality in one powerful tool, accessed via a REST API.
  • Retrofit - A type-safe HTTP client for Android and Java.
  • GSON - A modern JSON library for Kotlin and Java.
  • GSON Converter - A Converter which uses Moshi for serialization to and from JSON.
  • Material Components for Android - Modular and customizable Material Design UI components for Android.
  • Progress Button - Progress Button is a android library for hanling different types state like active, finished, enabled, disabled and reset with a single line of code.

Package Structure

com.rohit.Quizzon    # Root Package
.
├── data                # For data handling.
|   ├── local           # Room DB and its related classes
|   ├── remote          # Firebase, HarperDB and their relative classes
│   ├── model           # Model data classes, both remote and local entities
│
|
├── di                  # Dependency Injection
│   └── module          # DI Modules
|
├── ui                  # UI/View layer
|   ├── adapters        # All Adapters and Diffutils
│   ├── fragments       # All Fragments
│   ├── activity        # Containing All Activities
|   ├── viewmodels      # Viewmodel classes
|   ├── viewholders     # All Viewholders for adapter
│
|
├── Splash Screen       # Splash Screen for checking user state
|
└── utils               # Utility Classes / Kotlin extensions

Architecture

This app uses MVVM (Model View View-Model) architecture.

Want to Contribute 🙋‍♂️?

Awesome! If you want to contribute to this project, you're always welcome! See Contributing Guidelines.

Want to discuss? 💬

Have any questions, doubts or want to present your opinions, views? You're always welcome. You can start discussions.

Contact 📩

Have an project? DM us at 👇
Mail

LinkedIn

Donation 💰

If this project help you reduce time to develop, you can give me a cup of coffee :)

Buy Me A Coffee