# karthikdulam/courier_service_fe architecture

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

- Interactive diagram: https://gitdiagram.com/karthikdulam/courier_service_fe
- Repository: https://github.com/karthikdulam/courier_service_fe

## Overview

##### Project type and purpose
- courier_service_fe is a Vue 3 single-page application (SPA) front-end built with Vite and Vuetify.
- It provides the user interface for a courier service management system: managing companies, employees, couriers, customers, orders, routes, and deliveries.

##### File structure
- Top-level files: index.html, package.json, vite.config.js
- src/
- App.vue & main.js: application root and bootstrap
- plugins/: Vuetify setup, webfontloader
- router/index.js: Vue Router configuration (defines the SPA navigation).
- stores/globalStore.js: global state management (Pinia or Vuex–style store).
- services/: wrappers for API calls and business-logic (CommonServices, CourierServices, CustomerServices, FairCalculatorService, PriorityQueue, etc.).
- components/: reusable UI widgets (forms, dialogs, cards, route map, success popups).
- views/: page-level components mapped by router (Dashboard, Companies, Employees, Couriers, Customers, Deliveries, Login).
- images/: static assets.

##### README
- Emphasizes standard front-end build and run commands.

## Diagram (Mermaid)

```mermaid
flowchart TB
    Browser["Browser / Client"]:::external
    index["index.html"]:::ui
    main["main.js"]:::ui
    app["App.vue"]:::ui
    plugins_vuetify["Vuetify Plugin\n(vuetify.js)"]:::service
    plugins_font["Webfontloader Plugin\n(webfontloader.js)"]:::service
    router["Vue Router\n(index.js)"]:::ui
    store["Global Store\n(globalStore.js)"]:::state

    subgraph "UI Layer"
        direction TB
        subgraph Views
            direction TB
            v_dash["Dashboard\n(Dashboard.vue)"]:::ui
            v_comp["Companies\n(Company.vue)"]:::ui
            v_emp["Employees\n(Employees.vue)"]:::ui
            v_cour["Couriers\n(Couriers.vue)"]:::ui
            v_cust["Customers\n(Customers.vue)"]:::ui
            v_deliv["Deliveries\n(Deliveries.vue)"]:::ui
            v_login["Login\n(Login.vue)"]:::ui
        end
        subgraph Components
            direction TB
            c_add_cour["Add/Update Courier\n(AddUpdateCourier.vue)"]:::ui
            c_add_cust["Add/Update Customer\n(AddUpdateCustomer.vue)"]:::ui
            c_add_emp["Add/Update Employee\n(AddUpdateEmployee.vue)"]:::ui
            c_assign_emp["Assign Employee Dialog\n(AssignEmployee.vue)"]:::ui
            c_cust_card["Customer Details Card\n(CommonCustomerDetails.vue)"]:::ui
            c_emp_card["Employee Details Card\n(CommonEmployeeDetails.vue)"]:::ui
            c_delete["Delete Confirmation\n(CommonDeleteDialog.vue)"]:::ui
            c_cust_orders["Customer Orders List\n(CustomerOrdersList.vue)"]:::ui
            c_deliv_card["Deliveries Summary Card\n(DeliveriesCard.vue)"]:::ui
            c_route_display["Delivery Route Display\n(DeliveryAgentRoute.vue)"]:::ui
            c_route_map["Route Map View\n(RouteMapView.vue)"]:::ui
            c_success["Success Popup\n(SuccessPopup.vue)"]:::ui
            c_update_comp["Update Company Dialog\n(UpdateCompany.vue)"]:::ui
        end
    end

    subgraph "Service Layer"
        direction TB
        common["CommonServices.js"]:::service
        company["CompanyServices.js"]:::service
        courier["CourierServices.js"]:::service
        customer["CustomerServices.js"]:::service
        employee["EmployeeServices.js"]:::service
        user["UserServices.js"]:::service
        fare["FareCalculatorService.js"]:::service
        pq["PriorityQueue.js"]:::service
        services_index["services.js"]:::service
    end

    images["Static Assets\n(images)"]:::external
    vite["Vite Config\n(vite.config.js)"]:::service
    Backend["Backend API"]:::external
    MapService["Map/Geocoding API"]:::external

    Browser --> index
    index --> main
    main --> app
    main --> router
    main --> store
    main --> plugins_vuetify
    main --> plugins_font
    app --> router
    app --> store
    app --> plugins_vuetify
    app --> plugins_font

    router --> v_dash
    router --> v_comp
    router --> v_emp
    router --> v_cour
    router --> v_cust
    router --> v_deliv
    router --> v_login

    v_dash --> c_add_cust
    v_comp --> c_update_comp
    v_emp --> c_add_emp
    v_emp --> c_assign_emp
    v_emp --> c_emp_card
    v_cour --> c_add_cour
    v_cust --> c_add_cust
    v_cust --> c_cust_card
    v_cust --> c_cust_orders
    v_deliv --> c_deliv_card
    v_deliv --> c_route_display
    v_deliv --> c_route_map
    v_login --> user

    c_add_cour --> store
    c_add_cust --> store
    c_add_emp --> store
    c_assign_emp --> store
    c_cust_card --> store
    c_emp_card --> store
    c_delete --> store
    c_cust_orders --> store
    c_deliv_card --> store
    c_route_display --> store
    c_route_map --> store
    c_success --> store
    c_update_comp --> store

    store --> common
    common --> Backend
    company --> Backend
    courier --> Backend
    customer --> Backend
    employee --> Backend
    user --> Backend
    fare --> common
    pq --> common
    services_index --> common

    c_route_map --> MapService

    Backend --> common
    common --> store
    store --> v_dash
    store --> v_comp
    store --> v_emp
    store --> v_cour
    store --> v_cust
    store --> v_deliv
    store --> v_login

    images -.-> v_dash
    vite -.-> main

    classDef ui fill:#D0E6FF,stroke:#0366d6,color:#0366d6
    classDef state fill:#E6FFE6,stroke:#28A745,color:#28A745
    classDef service fill:#FFF5D6,stroke:#D69E00,color:#D69E00
    classDef external fill:#FFE6E6,stroke:#D73A49,color:#D73A49

    click index "https://github.com/karthikdulam/courier_service_fe/blob/development/index.html"
    click app "https://github.com/karthikdulam/courier_service_fe/blob/development/src/App.vue"
    click main "https://github.com/karthikdulam/courier_service_fe/blob/development/src/main.js"
    click router "https://github.com/karthikdulam/courier_service_fe/blob/development/src/router/index.js"
    click store "https://github.com/karthikdulam/courier_service_fe/blob/development/src/stores/globalStore.js"
    click plugins_vuetify "https://github.com/karthikdulam/courier_service_fe/blob/development/src/plugins/vuetify.js"
    click plugins_font "https://github.com/karthikdulam/courier_service_fe/blob/development/src/plugins/webfontloader.js"
    click common "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/CommonServices.js"
    click company "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/CompanyServices.js"
    click courier "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/CourierServices.js"
    click customer "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/CustomerServices.js"
    click employee "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/EmployeeServices.js"
    click user "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/UserServices.js"
    click fare "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/FairCalculatorService.js"
    click pq "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/PriorityQueue.js"
    click services_index "https://github.com/karthikdulam/courier_service_fe/blob/development/src/services/services.js"
    click v_dash "https://github.com/karthikdulam/courier_service_fe/blob/development/src/views/Dashboard.vue"
    click v_comp "https://github.com/karthikdulam/courier_service_fe/blob/development/src/views/Company.vue"
    click v_emp "https://github.com/karthikdulam/courier_service_fe/blob/development/src/views/Employees.vue"
    click v_cour "https://github.com/karthikdulam/courier_service_fe/blob/development/src/views/Couriers.vue"
    click v_cust "https://github.com/karthikdulam/courier_service_fe/blob/development/src/views/Customers.vue"
    click v_deliv "https://github.com/karthikdulam/courier_service_fe/blob/development/src/views/Deliveries.vue"
    click v_login "https://github.com/karthikdulam/courier_service_fe/blob/development/src/views/Login.vue"
    click c_add_cour "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/AddUpdateCourier.vue"
    click c_add_cust "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/AddUpdateCustomer.vue"
    click c_add_emp "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/AddUpdateEmployee.vue"
    click c_assign_emp "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/AssignEmployee.vue"
    click c_cust_card "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/CommonCustomerDetails.vue"
    click c_emp_card "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/CommonEmployeeDetails.vue"
    click c_delete "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/CommonDeleteDialog.vue"
    click c_cust_orders "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/CustomerOrdersList.vue"
    click c_deliv_card "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/DeliveriesCard.vue"
    click c_route_display "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/DeliveryAgentRoute.vue"
    click c_route_map "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/RouteMapView.vue"
    click c_success "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/SuccessPopup.vue"
    click c_update_comp "https://github.com/karthikdulam/courier_service_fe/blob/development/src/components/UpdateCompany.vue"
    click images "https://github.com/karthikdulam/courier_service_fe/tree/development/src/images"
    click vite "https://github.com/karthikdulam/courier_service_fe/blob/development/vite.config.js"
```
