📈 Dunhumby The complete Journey Dashboard

Table of Contents

• Technologies Used
• Description
  • App Overview
  • App Screenshots
• Demo
• Using Docker
• Installation
• Usage
• Project Structure
• Contact me
• Licence

---

Technologies Used

---

Description

This dataset contains household level transactions over two years from a group of 2,500 households who are frequent shoppers at a retailer. For certain households, demographic information as well as direct marketing contact history are included. The objective of this dashboard is to present relevant metrics about the financials of the stores, the demographic distribution of the customers and other key metrics. Multiple updates could be made to study the results of several marketing campaigns and product displays.

• App Overview

  • A python Notebook for the data management and creation of new metrics/columns
  • The streamlit app has 5 pages:
    • 👋 Dataset Presentation
    • 🔍 Data Exploration
    • 🏠 Demographic Data
    • 📦 Product_Data
    • 🧮 Sales Data

• App Screenshots

Dataset Presentation

Data Exploration

Demographic Data

Product Presence	Product Sales

General Sales	Sales By Demographic	Customer Acqiosition

---

Demo

The app demo is hosted & available on the following link: Demo Link

---

Using Docker

1. Pulling the Docker Image

To pull the Docker image from Docker Hub, run the following command:

# Pull the docker image
$ docker pull medkallel/dunhumby-the-complete-journey-dashboard:latest

# Or if you downloaded the .tar image
$ docker load -i dunhumby-the-complete-journey-dashboard.tar

2. Building the Docker Image

If you prefer to build the Docker image locally, navigate to the project directory and run:

# Build the docker image
$ docker build -t dunhumby-the-complete-journey-dashboard .

3. Running the Docker Container

To run the Docker container, use the following command:

# Run the docker container
$ docker run -p 8501:8501 dunhumby-the-complete-journey-dashboard

Tip

You can access the app on another device by following the link: http://<server-ip>:8501

---

Installation

Important

The project was done on Python 3.11.6

To run this project locally, follow these steps:

1. Clone the repository:

# Clone the repository
$ git clone https://github.com/Medkallel/Dunhumby-The-complete-Journey-Dashboard
# Navigate into the directory
$ cd Dunhumby-The-complete-Journey-Dashboard

2. Install the required dependencies:

# Install the requirements
$ pip install -r requirements.txt

---

Usage

# Run the Streamlit app
$ streamlit run Src/Streamlit/1_👋_Dataset_Presentation.py

Tip

You can access the app on another device by following the link: http://<server-ip>:8501

---

Project Structure

Here's a visual representation of the structure:
📦Project
 ┣ 📁.github/workflows
 ┃ ┗ 🦑github-docker-cicd.yaml # Used for the CI/CD pipeline
 ┣ 📁.streamlit/
 ┃ ┗ 📄config.toml
 ┣ 📁Assets/
 ┃ ┣ 🖼️ banner.jpg
 ┃ ┗ 🖼️ WordCloudMask.png
 ┣ 📁Data/ # Contains the dataset
 ┣ 📁Export/ # Contains the processed dataset
 ┣ 📁Doc/
 ┃ ┣ 📄dataset_description.json
 ┃ ┗ 📄dunnhumby - The Complete Journey User Guide.pdf
 ┣ 📁Src/
 ┃ ┣ 🐍Data_Exploration-Preprocessing.ipynb
 ┃ ┗ 📁Streamlit/
 ┃   ┣ 🐍1_👋_Dataset_Presentation.py
 ┃   ┣ 🐍config.py
 ┃   ┣ 🐍display_graph.py
 ┃   ┣📁pages/
 ┃    ┣ 🐍2_🔍_Data Exploration.py
 ┃    ┣ 🐍3_🏠_Demographic Data.py
 ┃    ┣ 🐍4_📦_Product_Data.py
 ┃    ┗ 🐍5_🧮_Sales_Data.py
 ┣ 🐳Dockerfile
 ┣ 📄README.md
 ┗ 📄requirements.txt

---

📫 Contact me

---

License

This project is under the CC BY-NC 4.0 Licence. Check the licence file for more info.