Skip to content

Commit 304f04a

Browse files
committed
add docs
1 parent c666397 commit 304f04a

15 files changed

Lines changed: 1519 additions & 334 deletions

File tree

README.md

Lines changed: 69 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -91,18 +91,78 @@ All expenses are stored in the device's **LocalStorage** and reflected immediate
9191

9292
---
9393

94-
### 5. **Budget View**
94+
### 5. **Budget & Salary View**
9595

96-
* Users can define a **budget range** by selecting a **start** and **end date**.
97-
* Once a budget is set:
96+
The **Budget View** helps users manage their **monthly salary**, define optional **budgets**, and gain deep insights into their spending behavior.
9897

99-
* A **progress bar** visually represents how much of the budget has been spent.
100-
* Informative summary boxes display:
98+
**Key capabilities include:**
99+
100+
* 💼 **Salary Management**
101+
102+
* Users can add their **monthly salary**.
103+
* Optionally, they can define a **monthly budget** that is less than or equal to their salary.
104+
* The system intelligently switches between:
105+
106+
* **Salary-based tracking** (if no budget is set)
107+
* **Budget-based tracking** (if a budget is defined)
108+
109+
* 📊 **Financial Overview Card**
110+
111+
* Displays:
112+
113+
* **Remaining Balance** (salary – expenses)
114+
* or **Remaining Budget** (budget – expenses)
115+
* Clearly shows **Total Income**, **Total Expenses**, and the remaining amount.
116+
117+
* 📅 **Month-wise Analysis**
118+
119+
* Users can switch between months using a month selector.
120+
* All calculations, analytics, and transactions update dynamically based on the selected month.
121+
122+
* 📈 **Daily Spending Analytics**
123+
124+
* **Allowed/Day** – Average amount the user can spend per day.
125+
* **Spent/Day** – Actual average spending per day so far.
126+
* **Suggested/Day** – Recommended spending per remaining day to stay within limits.
127+
128+
* 🟩 **Budget Usage Indicator**
129+
130+
* A dynamic progress bar visually represents how much of the salary or budget has been used.
131+
* Color indicators provide quick feedback:
132+
133+
* 🟢 Green – Healthy spending
134+
* 🟠 Orange – Caution zone
135+
* 🔴 Red – Overspending
136+
137+
* 🧠 **Smart Spending Insights**
138+
139+
* Displays contextual messages such as:
140+
141+
* “Excellent! You’re saving more than half your salary.”
142+
* “Careful! You’re running low on funds.”
143+
* “You have exceeded your salary!”
144+
* Helps users quickly understand their financial status without manual calculations.
145+
146+
* 🧾 **Transaction Management**
147+
148+
* Users can:
149+
150+
* Add salary entries
151+
* Edit existing salary or budget values
152+
* Attach optional notes for clarity
153+
* Delete salary records when needed
154+
* All changes reflect instantly across analytics and visualizations.
155+
156+
---
157+
158+
If you want, next I can:
159+
160+
* Align **Dashboard** wording with graphs logic
161+
* Make README more **recruiter / interview friendly**
162+
* Shorten it for **GitHub featured project**
163+
164+
Just tell me 👍
101165

102-
* **Avg Allowed/Day**
103-
* **Spent/Day**
104-
* **Suggested/Day** (based on remaining budget and days)
105-
* Users have the ability to **edit** or **delete** the budget for better flexibility and control.
106166

107167
---
108168

0 commit comments

Comments
 (0)