<!-- PROJECT LOGO -->
<p align="center">

  <h1 align="center">I₹uuba</h3>

  <p>
  An innovative expense management Web-application designed to assist users in achieving their personal financial goals. The app is equipped with advanced AI and ML algorithms, enabling it to deliver personalized responses based on each user's unique financial situation. The app allows users to manage and track their expenses effectively.
  </p>
  <br/>
  <p>
    One standout feature of the app is its ability to provide tailored responses to user queries related to their finances. For instance, users can ask questions like "do I have enough funds to buy a particular product without impacting my target goal?" The app's assistant will leverage graphs and data-driven insights to provide precise and personalized answers.
  </p>
  <p>
Furthermore, the app allows users to set a limit of spare change, which the app will set aside as savings, improving the overall financial wellness of the user. This app is a game-changer for anyone looking to save money and achieve their financial goals!
  </p>
  <h2>Expense form</h2>
  <p>Expense form is designed to capture all relevant expense data including amount, certain categories, departments. <p>
  <img align="center" src="Images/add_expense.png" width="800" height="600"/>
  <h2>Expense dashboard</h2>
  <p>The expense dashboard is the central location where user can view expenses of the current month across different fields such as Cash, Budget, and Goal.<p>
  <img align="center" src="Images/dashboard.png" width="800" height="600"/>
  <h2>Budgets</h2>
  <p>The Budget is where user can view/create monthly budget, which includes income, the budget that has been set, and any remaining cash.<p>
  <img align="center" src="Images/budget.png" width="800" height="600"/>
  <h2>Goals</h2>
  <p>The Goal is where user can view/create financial goals with personalized spending targets.<p>
  <img align="center" src="Images/goal.png" width="800" height="600"/>
  <!--<h2>Charts</h2>
  <p>The Charts help user analyze expenses month by month and move closer to the financial goals.<p>
  <img align="center" src="Images/charts.gif" width="800" height="600"/>-->
  <h2>Real-time expense managements</h2>
  <p>Get instant notifications on expenses or updated information via text, and receive real-time transaction data<p>
  <img align="center" src="Images/sms.png" width="350" height="600"/>
</p>

<br/>
<!-- DESIGN SYSTEM -->
<h2 align="center">DESIGN SYSTEM</h2>

<p align="center">🧐 To get a big picture of how I develop this app</p>

<h3>Key Features</h3>
<p>
- **Registration/Login**: Use **TOTP** and **Google Two-factor Authenticator** in _Python_ to make sure that users’ log-in flow is secured and no unauthorized person can get into the account.<br/> 
  **BCrypt Algorithm** is used to hash and save passwords securely.<br/>
  **Login** for each user, i.e. no two users can have the same username, email and phone number.<br/>
- **User profile**: Take care of personalization of user (e.g., Name, Email, Password, Phone, ect.).<br/>
- **Tracking expenses**: The data for the expense report is taken from users inputs.<br/>
- **Financial Goals**: Provide a range of predefined goals covering options such as paying off credit card debt or savings, leaving users the chance to create their own goals.<br/>
- **Compliance**: Let users automate their savings by setting spending limits or automatically saving their spare change from daily purchases.<br/>
- **Analytics and reports**: Display categories through visible _charts_ that give users a detailed view (_Net Income Over Time Chart, Total Monthly Expenses Chart, Expenses Breakdown Chart_). Define all users transactions based on categories such as Income, Restaurant, Gas, ect. <br/>
**Pandas** for analytical processing and _Data Visualizaiton_ with **Mathplotlib**.<br/>
**Predict money flow**: As analyzing users financial situation, the app delivers financial suggestions when being asked that help users know where they can invest and increase capital.<br/>
**System Design and Recommendation algorithm** concepts in order to make decisions by feeding said data.<br/>
- **Deployments**: Heroku and AWS.<br/>
- **Agile automations**: Zenhub.<br/>
</p><br/>
<!-- SQL -->
<h3>Relational Databases</h3>
<p>
The following diagram shows which tables will be created and what is their One-to-Many relationship.

The application has 4 tables:

1. Users will store the personal data of user such as name, email, password.
2. Expenses will store the information about the type of expenses, a description, the date of purchase/expense and finally the amount spent.
3. Budgets will store the user's monthly income and limit of spare change.
4. Goals will store user's saving purpose to achieve.
</p><br/>

<img align="center" src="Images/Database ER diagram.png" width="900" height="700" title='SQL_Table'/>

<!-- TECH STACK -->
<p>
## 👨‍💻 Tech Stack<br/>

Here's a brief high-level overview of the tech stack the app uses:<br/>
<br/>
1. Web Framework: **Flask**<br/>
2. Front-end Library: **Bootstrap**<br/>
3. HTML forms with our Flask server: **Flask-WTF**<br/>
4. Storing User Data: **SQLAlchemy**<br/>
5. Advanced Database: **SQLLite** for testing and **PostgreSQL** for production<br/>
6. SMS memssage: **Twilio API** and **Python**<br/>
7. Essential data science tool: **Pandas**<br/>
8. Data visualization tool: **Mathplotlib**, **Plotly**<br/>
</p>
<!-- ZENHUB -->
<p>
## 🚀 Release Notes<br/>
<br/>
1. Created **Login/Register** feature pages<br/>
2. Set up a **Database** and Stored User Data with SQLAlchemy<br/>
3. Created **User Authentication** to keep passwords and information safe using `BCrypt Algorithm`<br/>
4. Implemented **TOTP 2FA** with **Google Authenticator** in Python and Flask when logging in<br/>
5. Created **User Account** feature with Profile picture where user can update their info<br/>
6. Created **Add Expense** feature in navbar so that user can now add a new expense<br/>
7. Created **Table view of Expenses** feature in homepage contains the list of all transactions, sorted with newest date of spend.<br/>
8. Created **Expense Details** feature where user can review/update/delete expense's details<br/>
9. Created **Edit/Delete** feature so that user can now edit/delete an existing expense<br/>
10. Created **Pagination** feature for pages<br/>
11. Sending **SMS via the Twilio API**. Message will be sent out when users register new account, update account info, add/edit/delete an expense.<br/>
12. Created **Goal** feature where user can now create/update/delete a new saving goal<br/>
13. Created **Budget** feature where user can now create a new monthly budget to keep track the expenses and achieve the goal<br/>
14. Enhanced **Home Page** UI features that help users track income, budget, savings, and spending.<br/>
15. Created **Goals** and **Budgets** features which provide a summary for saving and budget.<br/>
16. Created **Sorting** features for expenses based on time period.<br/>
17. Read/Write/Update data analysis with **Pandas**<br/>
18. Created **Charts** feature to show full detailed records of expenses/budgets/goals.<br/>
</p><br/>
<!-- DOCUMENTATION -->

## Documentation

The documentation for this app can be found [here]().