Skip to content

Latest commit

 

History

History
81 lines (66 loc) · 5.38 KB

README.md

File metadata and controls

81 lines (66 loc) · 5.38 KB
Raw

ShopKart

This is an Android shopping application built using Android Jetpack Compose with a Firebase backend. The app follows the MVVM (Model-View-ViewModel) architecture and has a minimum supported Android version of Android 10.

Features

  1. User authentication: The app allows users to create accounts, log in, and log out using Firebase Authentication.
  2. Product listing: Users can view a list of products available for purchase.
  3. Product details: Users can view detailed information about a specific product, including its price, description, and availability.
  4. Shopping cart: Users can add products to their shopping cart and view the items they have selected for purchase.
  5. Order placement: Users can place orders for the items in their shopping cart and receive confirmation of their purchase.
  6. Order history: Users can view their order history, including details of past purchases.
  7. Real-time updates: The app leverages Firebase Realtime Database or Firestore to provide real-time updates for product availability and order status.

Screenshots

Prerequisites

Before running the app, make sure you have the following:

  1. Android Studio Flamingo 2022.2.1 or later.
  2. Android SDK with a minimum API level of 29 (Android 10).
  3. Firebase project with Firestore or Realtime Database configured.
  4. Google services JSON file (google-services.json) placed in the app module.

Getting Started

  1. Clone the repository: git clone https://github.com/Kawaki22/ShopKart.git Or Download the Zip file
  2. Open the project in Android Studio.
  3. Create a Firebase project and configure Firestore or Realtime Database.
  4. Add your google-services.json file from your firebase console to the app module.
  5. Enable Email/Password and Google sign-in method from Authentication section in firebase.
  6. Add your Google Web Client Id in ShopKartUtils for Google Sign In to work.

Accounts and Login

This app has 3 types of logins

  1. Users
  2. Admin
  3. Employee

Create an admin account from firebase console in the format admin.example@gmail.com

Dependencies

The project uses the following dependencies:

  1. Jetpack Compose: A modern UI toolkit for building native Android apps.
  2. Firebase: Provides backend services for authentication, real-time updates, and database storage.
  3. Coroutines: Provides asynchronous programming capabilities.
  4. ViewModel: Part of the Jetpack library that provides a lifecycle-aware container for UI-related data.
  5. Navigation: Handles navigation between different screens and features in the app.
  6. Hilt: Used for dependency injection.

For a complete list of dependencies, refer to the build.gradle file in the app module.

License

The project is licensed under the GPLv3 License. See the LICENSE file for more information.

Acknowledgements

  1. The Android Jetpack Compose team for their excellent work on the framework.
  2. The Firebase team for providing a powerful backend infrastructure.