iBrokeTheCode commited on
Commit
a16dfb8
Β·
1 Parent(s): 6c58c49

chore: Update README for GitHub repo

Browse files
Files changed (2) hide show
  1. LICENSE +21 -0
  2. README.md +16 -6
LICENSE ADDED
@@ -0,0 +1,21 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ MIT License
2
+
3
+ Copyright (c) 2025 AlexRTC
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
README.md CHANGED
@@ -1,4 +1,4 @@
1
- ---
2
  title: E-Commerce ELT
3
  emoji: πŸƒ
4
  colorFrom: indigo
@@ -7,7 +7,7 @@ sdk: docker
7
  pinned: true
8
  license: mit
9
  short_description: Extract, Load, Transform Pipeline applied to an E-Commerce
10
- ---
11
 
12
  # E-Commerce ELT Pipeline
13
 
@@ -15,15 +15,21 @@ short_description: Extract, Load, Transform Pipeline applied to an E-Commerce
15
 
16
  1. [Description](#1-description)
17
  2. [Stack](#2-stack)
 
18
 
19
  ## 1. πŸ›οΈ Description
20
 
21
- This project analyzes e-commerce data from a Brazilian marketplace to explore key business metrics related to **revenue** and **delivery performance**. Using an interactive Marimo application, the analysis provides insights into:
22
 
23
- - **Revenue:** Annual revenue, popular product categories, and sales by state.
24
- - **Delivery:** Delivery performance, including time-to-delivery and its correlation with public holidays.
25
 
26
- The data pipeline processes information from [multiple CSV files](https://www.kaggle.com/datasets/olistbr/brazilian-ecommerce) and a [public API](https://date.nager.at/Api), storing and analyzing the results using Python. The final interactive report is presented as a Hugging Face Space built with Marimo.
 
 
 
 
 
 
27
 
28
  ## 2. πŸ§‘β€πŸ’» Stack
29
 
@@ -37,3 +43,7 @@ The data pipeline processes information from [multiple CSV files](https://www.ka
37
  - [Requests](https://requests.readthedocs.io/en/latest/): A Python library for making HTTP requests.
38
  - [Ruff](https://github.com/charliermarsh/ruff): An extremely fast Python linter and code formatter, written in Rust.
39
  - [uv](https://github.com/astral-sh/uv): An extremely fast Python package and project manager, written in Rust.
 
 
 
 
 
1
+ <!-- ---
2
  title: E-Commerce ELT
3
  emoji: πŸƒ
4
  colorFrom: indigo
 
7
  pinned: true
8
  license: mit
9
  short_description: Extract, Load, Transform Pipeline applied to an E-Commerce
10
+ --- -->
11
 
12
  # E-Commerce ELT Pipeline
13
 
 
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
28
+ - Customer locations and product categories
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
 
 
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)