/Ecommerce

Ecommerce App built using Android - Jetpack Compose

Primary LanguageKotlin

E-Commerce - Everything at tip of your finger

About

A simple e-commerce app that connects local retailers with people around

Built With 🛠

  • Kotlin - A programming language for Android development.
  • Jetpack Compose - For Ui Components
  • Coroutine - For asynchronous and more..
  • Flow - For stream data that asynchronously
  • Android Architecture Components - Collection of libraries that help you design robust, testable, and maintainable apps.
    • LiveData - Data objects that notify views when the underlying database changes.
    • 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.
    • Room - SQLite object mapping library.
  • Dependency Injection -
    • Dagger2 - Standard library to incorporate Dagger dependency injection into an Android application.
  • Retrofit - A Complete Fast Android Networking Library that also supports HTTP/2.
  • Gson - A modern JSON library for Kotlin and Java.
  • Glide - An image loading and caching library for Android focused on smooth scrolling.
  • Material Components for Android - Modular and customizable Material Design UI components for Android.
  • Lottie Animation - Cool Animations in an Android App.

Package Structure

com.stymsaw.myshop    # Root Package
.
├── data                # For data handling.
│   ├── local           # Local Persistence Database. Room  and shared perf
|   │   └──dao            # Data Access Object for Room   
|   |   
│   ├── remote          # Remote Data Handlers     
│   ├── model           # Model classes
|   │   ├── api         # Model classes for Api
|   |   └── db          # Model classes for Db
│   └── repository      # Single source of data.
|
├── navigation          # PArent Navhost for navigation  
|
├── di                  # Dependency Injection  
│   ├── module          # DI Modules
│   ├── component       # DI Components       
│   └── scope           # Dependency Scope
|
├── ui                  # Activity/View layer
│   ├── base            # Base View
│   ├── custom          # Custom Views
│   ├── home screen     # Homescreen components and ViewModel
│   ├── productdetails  # Product details and ViewModel
│   ├── searchscreen    # Searchscreen and ViewModel
│   ├── splashscreen    # Splashscreen 
│   └──  theme           # App themeing details
│   
|
└── utils               # Utility Classes

Architecture

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

Requirements

  • JDK 8
  • Latest Android SDK tools
  • Latest Android platform tools
  • Android SDK 21 or newer
  • AndroidX

Setup Project

  1. Open Android Studio and select Get from Version Control.
  2. Add URL as https://github.com/stymsaw/Ecommerce and proceed.
  3. Sync The project and you are done.

License

MIT License

Copyright (c) 2023 Satyam Saw

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.