# sahuadarsh0/gogrocery architecture

> Architecture diagram of the GitHub repository sahuadarsh0/gogrocery, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/sahuadarsh0/gogrocery
- Repository: https://github.com/sahuadarsh0/gogrocery

## Overview

##### Project Type and Purpose
- It’s a native Android mobile client for an e-commerce platform (inspired by Amazon, BigBasket, etc.).
- The app handles user registration/login, product browsing, cart management, order placement, OTP flows, and profile management.

##### File Structure (Highlights)
- Top-level: build scripts (`build.gradle`, `gradle/`, `gradlew`), CI config (`.github/workflows/android.yml`), app binary (`app.apk`).
- `app/`: Android Studio module
– `src/main/java/app/infiniverse/grocery`: Activities & core logic (UI controllers + business logic).
– `src/main/res`: Layouts, drawables, animations, menus (presentation assets).
– `MyApp.java`: Application class for global initialization.
– Utility classes: `Converter`, `ConnectivityReceiver`.
– Data models: `Product.java`, `GridItem.java`, etc.
– Adapters: `Cart_Item_Adapter`, `Customer_Order_Adapter`, etc.
– Gradle config including ProGuard rules and dependencies.
- `src/test` and `src/androidTest`: Unit and instrumentation tests.
- CI: GitHub Actions workflow for Android build & test.

##### README Insights
- It’s still WIP, deprecated v1.0 branch.
- No backend code included—assumes RESTful API services exist elsewhere.
- Screenshots illustrate key user flows: splash → home → category → product detail → cart → order → profile.

##### Main Components & Their Interactions
A. Mobile Client (Android App)
- Presentation Layer: Activities & Fragments rendering XML layouts.
- Data Layer: Model classes (Product, Order, Cart), local conversion utilities.
- Network Layer: HTTP client (Retrofit/Volley/etc.), `ConnectivityReceiver` monitors connectivity.
- Business Logic: Cart management (`MyCart`), OTP & authentication flows, order submissions.
- Application Context: `MyApp` for dependency setup (e.g., API client, logging).

B. Backend Services (External, not in repo)
- Authentication API (login/register/forget-password/OTP).
- Product Catalog API (list by category, search).
- Cart & Order API (add/remove items, place order, fetch order history).
- Profile Service (get/update user details).
- Payment Gateway (third-party service invoked on checkout).

C. CI/CD Pipeline
- GitHub Actions (`android.yml`) to build APK, run tests, possibly deploy artifacts.

##### Architectural Patterns & Design Principles
- Follows a classic Android MVC/MVP style:
- Controllers: Activities/Fragments
- Models: Plain Java objects
- Views: XML layouts, Adapters
- Separation of concerns: UI, data models, network utils separated into packages.
- Resiliency: Connectivity checks before network calls.
- Testability: Unit and instrumentation tests included.

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Mobile Client
    subgraph "Mobile Client"
        direction TB
        Presentation["Presentation Layer\n(Activities & Fragments)"]:::frontend
        Data["Data Layer\n(Product, GridItem, MyCart)"]:::model
        Network["Network Module\n(HTTP Client, ConnectivityReceiver, Converter)"]:::network
        Logic["Business Logic\n(Cart & Order, Auth Flows)"]:::logic
        Context["Application Context\n(MyApp)"]:::context
        Assets["Presentation Assets\n(layouts, drawables, menus)"]:::assets
        TestsUnit["Unit Tests"]:::test
        TestsInstr["Instrumented Tests"]:::test
    end

    %% External Services
    subgraph "External Services"
        direction TB
        AuthAPI["Authentication API"]:::external
        CatalogAPI["Product Catalog API"]:::external
        CartOrderAPI["Cart & Order API"]:::external
        ProfileAPI["Profile Service"]:::external
        Payment["Payment Gateway"]:::external
    end

    %% CI/CD
    CI["CI/CD Pipeline\n(GitHub Actions)"]:::ci

    %% Data Flow
    Presentation -->|"invokes"| Logic
    Logic -->|"HTTP Requests"| Network
    Network -->|"Auth, Catalog, Cart/Order, Profile Calls"| AuthAPI
    Network --> CatalogAPI
    Network --> CartOrderAPI
    Network --> ProfileAPI
    CartOrderAPI --> Payment
    AuthAPI --> Network
    CatalogAPI --> Network
    CartOrderAPI --> Network
    ProfileAPI --> Network
    Network -->|"JSON Response"| Data
    Data --> Presentation
    Context --> Presentation
    Context --> Logic
    Assets --> Presentation
    TestsUnit --> Logic
    TestsInstr --> Presentation

    %% CI Flow
    CI -->|"build & test"| Mobile_Client_Build[APK Artifact]
    Mobile_Client_Build

    %% Click Events
    click Presentation "https://github.com/sahuadarsh0/gogrocery/tree/master/app/src/main/java/app/infiniverse/grocery"
    click Data "https://github.com/sahuadarsh0/gogrocery/tree/master/app/src/main/java/app/infiniverse/grocery"
    click Network "https://github.com/sahuadarsh0/gogrocery/tree/master/app/src/main/java/app/infiniverse/grocery"
    click Logic "https://github.com/sahuadarsh0/gogrocery/tree/master/app/src/main/java/app/infiniverse/grocery"
    click Context "https://github.com/sahuadarsh0/gogrocery/blob/master/app/src/main/java/app/infiniverse/grocery/MyApp.java"
    click Assets "https://github.com/sahuadarsh0/gogrocery/tree/master/app/src/main/res"
    click CI "https://github.com/sahuadarsh0/gogrocery/blob/master/.github/workflows/android.yml"
    click TestsUnit "https://github.com/sahuadarsh0/gogrocery/blob/master/app/src/test/java/app/infiniverse/grocery/ExampleUnitTest.java"
    click TestsInstr "https://github.com/sahuadarsh0/gogrocery/blob/master/app/src/androidTest/java/app/infiniverse/grocery/ExampleInstrumentedTest.java"

    %% Styles
    classDef frontend fill:#D0E4FF,stroke:#0366d6,color:#0366d6;
    classDef model fill:#E8F0FE,stroke:#1A73E8,color:#1A73E8;
    classDef network fill:#D1F2EB,stroke:#20C997,color:#20C997;
    classDef logic fill:#FFF4D6,stroke:#FFC107,color:#FF8F00;
    classDef context fill:#EDE7F6,stroke:#673AB7,color:#5E35B1;
    classDef assets fill:#F0F4C3,stroke:#CDDC39,color:#AFB42B;
    classDef external fill:#E6F4EA,stroke:#34A853,color:#0F9D58;
    classDef ci fill:#FFE8D6,stroke:#FB8C00,color:#EF6C00;
    classDef test fill:#F5F5F5,stroke:#9E9E9E,color:#616161;
```
