iBrokeTheCode commited on
Commit
f881c94
·
1 Parent(s): e2ab41b

chore: Update README with more project details

Browse files
Files changed (2) hide show
  1. README.md +52 -19
  2. public/dashboard-demo.png +3 -0
README.md CHANGED
@@ -13,15 +13,16 @@ short_description: Extract, Load, Transform Pipeline applied to an E-Commerce
13
 
14
  ## Table of Contents
15
 
16
- 1. [Description](#1-description)
17
- 2. [Stack](#2-stack)
18
- 3. [Entity Relationship Diagram](#3-entity-relationship-diagram)
 
19
 
20
- ## 1. 🛍️ Description
21
 
22
- This dashboard presents insights from the real-world [Brazilian E-Commerce Public Dataset by Olist](https://www.kaggle.com/datasets/olistbr/brazilian-ecommerce), which includes data on over **100,000 orders** placed between **2016 and 2018** across various online marketplaces in Brazil. It also integrates data from the [Public Holiday API](https://date.nager.at/Api) to analyze sales performance during national holidays.
23
 
24
- The dataset offers a detailed view of the e-commerce experience, including:
25
 
26
  - Order status, prices, and payment types
27
  - Freight and delivery performance
@@ -29,21 +30,53 @@ The dataset offers a detailed view of the e-commerce experience, including:
29
  - Customer reviews and satisfaction
30
 
31
  > [!IMPORTANT]
32
- > Check the Dashboard deployed on Hugging Face Spaces: [E-Commerce ELT](https://huggingface.co/spaces/iBrokeTheCode/E-Commerce_ELT)
33
 
34
- ## 2. 🧑‍💻 Stack
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
35
 
36
  - [Marimo](https://github.com/marimo-team/marimo): A Python library for building interactive dashboards.
37
- - [Hugging Face Spaces](https://huggingface.co/docs/hub/spaces-config-reference): A platform for hosting and sharing interactive machine learning demos and applications.
38
- - [Pandas](https://pandas.pydata.org/): A Python library for data manipulation and analysis.
39
- - [Plotly](https://plotly.com/python/): A Python library for interactive data visualization.
40
- - [Matplotlib](https://matplotlib.org/): A Python library for creating static, animated, and interactive visualizations.
41
- - [Seaborn](https://seaborn.pydata.org/): A Python library for creating statistical graphics.
42
- - [SQLAlchemy](https://www.sqlalchemy.org/): A Python library for interacting with databases.
43
- - [Requests](https://requests.readthedocs.io/en/latest/): A Python library for making HTTP requests.
44
- - [Ruff](https://github.com/charliermarsh/ruff): An extremely fast Python linter and code formatter, written in Rust.
45
- - [uv](https://github.com/astral-sh/uv): An extremely fast Python package and project manager, written in Rust.
46
-
47
- ## 3. Entity Relationship Diagram
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
48
 
49
  ![ERD](./public/erd-schema.png)
 
13
 
14
  ## Table of Contents
15
 
16
+ 1. [Project Description](#1-project-description)
17
+ 2. [Methodology & Key Features](#2-methodology--key-features)
18
+ 3. [Technology Stack](#3-technology-stack)
19
+ 4. [Dataset](#4-dataset)
20
 
21
+ ## 1. Project Description
22
 
23
+ This project showcases an Extract, Load, and Transform (ELT) pipeline applied to a real-world e-commerce dataset. The primary goal is to extract valuable business insights from transactional data and present them through an interactive dashboard. The pipeline integrates data from the **Brazilian E-Commerce Public Dataset by Olist**, which contains over **100,000 orders** from 2016 to 2018, and also incorporates data from the Public Holiday API to analyze sales performance during national holidays.
24
 
25
+ The dashboard provides a detailed view of the e-commerce experience, including:
26
 
27
  - Order status, prices, and payment types
28
  - Freight and delivery performance
 
30
  - Customer reviews and satisfaction
31
 
32
  > [!IMPORTANT]
33
+ > You can check out the deployed dashboard here: [E-Commerce ELT](https://huggingface.co/spaces/iBrokeTheCode/E-Commerce_ELT)
34
 
35
+ ![Dashboard](./public/dashboard-demo.png)
36
+
37
+ ## 2. Methodology & Key Features
38
+
39
+ The ELT pipeline extracts raw data, loads it into a structured format, and then transforms it to generate key metrics and visualizations. The analysis is presented using an interactive dashboard built with Marimo, a Python library.
40
+
41
+ ### Key Features:
42
+
43
+ - **Data Integration**: Combines e-commerce order data with public holiday information to analyze temporal sales patterns.
44
+ - **Data Transformation**: Cleans and prepares raw data for analysis, enabling the calculation of key performance indicators (KPIs).
45
+ - **Interactive Dashboard**: Provides a dynamic and user-friendly interface for exploring business insights.
46
+
47
+ ## 3. Technology Stack
48
+
49
+ This project was built using the following technologies and libraries:
50
+
51
+ **Dashboard & Hosting:**
52
 
53
  - [Marimo](https://github.com/marimo-team/marimo): A Python library for building interactive dashboards.
54
+ - [Hugging Face Spaces](https://huggingface.co/docs/hub/spaces-config-reference): Used for hosting and sharing the interactive dashboard.
55
+
56
+ **Data Analysis & Visualization:**
57
+
58
+ - [Pandas](https://pandas.pydata.org/): For data manipulation and analysis.
59
+ - [Plotly](https://plotly.com/python/): For creating interactive data visualizations.
60
+ - [Matplotlib](https://matplotlib.org/): For creating static visualizations.
61
+ - [Seaborn](https://seaborn.pydata.org/): For creating statistical graphics.
62
+
63
+ **Data Handling & Utilities:**
64
+
65
+ - [SQLAlchemy](https://www.sqlalchemy.org/): For interacting with databases.
66
+ - [Requests](https://requests.readthedocs.io/en/latest/): For making HTTP requests to external APIs.
67
+
68
+ **Development Tools:**
69
+
70
+ - [Ruff](https://github.com/charliermarsh/ruff): A fast Python linter and code formatter.
71
+ - [uv](https://github.com/astral-sh/uv): A fast Python package installer and resolver.
72
+
73
+ ## 4. Dataset
74
+
75
+ This project utilizes the **Brazilian E-Commerce Public Dataset by Olist** from Kaggle, a public dataset containing details on over 100,000 orders. The data spans from 2016 to 2018 and includes a wide range of transactional information.
76
+
77
+ - **Source**: [Kaggle Dataset](https://www.kaggle.com/datasets/olistbr/brazilian-ecommerce)
78
+ - **Additional Data**: The project also integrates data from the [Public Holiday API](https://date.nager.at/Api).
79
+
80
+ Here is the ERD diagram for the database schema:
81
 
82
  ![ERD](./public/erd-schema.png)
public/dashboard-demo.png ADDED

Git LFS Details

  • SHA256: 9d9d4079e89c5429f6359c9891154227aae2002c12ef5aee8b2de9e8150587f4
  • Pointer size: 130 Bytes
  • Size of remote file: 85 kB