Skip to content

Commit e0e7c70

Browse files
docs: add project README.md with full documentation
Created comprehensive README file detailing the Digital Ecosystem Dashboard. Included project overview, core features (Telecommunications plans, MarVin Pay, and interactive Modals), technology stack (React and Vite), and local setup instructions.
1 parent 69e42af commit e0e7c70

1 file changed

Lines changed: 64 additions & 0 deletions

File tree

README.md

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
# 📱 Digital Ecosystem Dashboard (MarVin Provider)
2+
3+
![Project Status](https://img.shields.io/badge/STATUS-ACTIVE-brightgreen?style=for-the-badge)
4+
![License](https://img.shields.io/badge/LICENSE-MIT-blue?style=for-the-badge)
5+
6+
## 📖 About the Project
7+
8+
This project is a **Modern Digital Ecosystem Interface** built with React.js. It simulates a comprehensive dashboard for a telecommunications and financial services provider, allowing users to manage:
9+
10+
1. **Telecom Plans:** Tracking fiber internet (Fibra) and mobile data usage.
11+
2. **Financial Services:** A digital wallet simulation (MarVin Pay), personal loans, and Open Finance integrations.
12+
3. **Value-Added Services:** Device insurance and subscription management (e.g., Disney+).
13+
14+
The system was built with a focus on **Mobile-First** design, providing an "App-like" experience directly in the web browser, featuring bottom navigation and dynamic side drawers.
15+
16+
---
17+
18+
## 🚀 Features
19+
20+
* **Dynamic Modals & Sidebars:** Centralized state management to smoothly transition between dozens of different screens (Invoices, Recharges, Profile, Store) without reloading.
21+
* **Typewriter Animation:** Custom React `useEffect` hook that greets the user with an animated text effect.
22+
* **App-Like Navigation:** Features a sticky bottom navigation bar and a responsive side-drawer menu for advanced settings.
23+
* **Real-Time UI Updates:** State-driven interfaces that instantly reflect user interactions, powered by React Hooks (`useState`).
24+
* **Modern Iconography:** Integration with `lucide-react` for clean, scalable, and professional SVG icons.
25+
26+
---
27+
28+
## 🛠️ Technologies Used
29+
30+
![React](https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB)
31+
![JavaScript](https://img.shields.io/badge/JavaScript-F7DF1E?style=for-the-badge&logo=javascript&logoColor=black)
32+
![CSS3](https://img.shields.io/badge/CSS3-1572B6?style=for-the-badge&logo=css3&logoColor=white)
33+
![Vite](https://img.shields.io/badge/Vite-B73BFE?style=for-the-badge&logo=vite&logoColor=FFD62E)
34+
35+
---
36+
37+
## 📱 How to Use
38+
39+
1. **Access the Live Version:** [Click here to view the App](https://marcossoftwareengineering.github.io/Provider/) *(Update link if necessary)*
40+
2. **Interact with Cards:** Click on the main dashboard cards (Fibra, Móvel, Pay, Seguros) to open detailed modals.
41+
3. **Navigate:** Use the bottom navigation bar to switch between "Pra você", "Assinaturas", "Loja", "Benefícios", and "Pay".
42+
4. **Open Sidebar:** Click the Hamburger Menu icon (top right) to access billing (Central de faturas) and Open Finance options.
43+
44+
---
45+
46+
## 📂 Project Structure
47+
48+
```text
49+
1. index.html Main application structure (Vite entry point)
50+
2. App.jsx Core React component (States, Modals, Layout)
51+
3. App.css Styles, CSS Variables, and Responsive Layouts
52+
4. main.jsx React DOM rendering and StrictMode wrapper
53+
5. README.md Project documentation
54+
```
55+
56+
---
57+
58+
## 👷 Author
59+
Marcos Vinicius
60+
Software Engineering Student & Trainee Full Stack
61+
62+
Founder of Marvin Site Builders — Focusing on creating high-performance digital ecosystems and landing pages.
63+
64+
[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/marcos-vinicius-souza-silva-29025a294)

0 commit comments

Comments
 (0)