Repository navigation
User Documentation
This document explains how to run and use Aria's Budget Tracker application on a Linux x64 system.
You can follow the steps in the Deployment Guide to run the application on your Linux system. Once the application is running in your terminal, you will see the main menu.
The Budget Tracker application allows you to manage your budget by adding income and expenses. Here's how to use the main features:
-
Main Menu: When the application starts, you will see the following main menu in your terminal:
Please choose an option: > Add Expense View Remaining Budget Set Spending Limits ExitThe
>symbol indicates the currently selected option. You can use the up and down arrow keys on your keyboard to move the>symbol to highlight the option you want to choose. Press Enter to select the highlighted option. -
Add Expense:
- Use the up or down arrow keys to select "Add Expense" on the main menu (so that the
>is next to it). - Press Enter to proceed.
- The console will then display the "Add a New Expense" screen, prompting you to select a category:
Add a New Expense Select a category: > Communication Eating Out Entertainment Groceries Miscellaneous Back- Use the up and down arrow keys to move the
>symbol to highlight the expense category you want to choose (e.g., "Communication"). - Press Enter to select the highlighted category.
- The application will then ask you to enter the amount spent on the selected category. For example, if you selected "Communication", you will see:
Enter the amount spent on Communication:- Type the numerical value of the expense (e.g.,
100) and press Enter. - The application will confirm that the expense has been added and update the database. You will see a confirmation message like:
Expense of $100.00 added to Communication. Press Enter to continue...- Press Enter again to return to the main menu.
Note: The process for adding expenses to other categories (Eating Out, Entertainment, Groceries, Miscellaneous) follows the same steps: select the category, enter the amount, and confirm.
- Use the up or down arrow keys to select "Add Expense" on the main menu (so that the
-
View Remaining Budget:
- Use the arrow keys to select "View Remaining Budget" on the main menu (so that the
>is next to it). - Press Enter to proceed.
- The console will then display the "Budget Status" screen, showing the remaining budget for each category (in white text), along with a visual representation (a progress bar) and any warnings if a budget limit is close to being met (in yellow text) or has been met or exceeded (in red text). For example:
Budget Status Groceries: Remaining = $17.00 [=================== ] 97% WARNING: Groceries budget is almost met! Eating Out: Remaining = $0.00 [====================] 100% WARNING: Eating Out budget is met! Entertainment: Remaining = $200.00 [ ] 0% Communication: Remaining = -$25.00 [====================] 100% WARNING: Communication budget exceeded! Miscellaneous: Remaining = $200.00 [ ] 0% Press Enter to continue...- This screen provides an overview of your spending status across different categories.
- After reviewing the budget status, press Enter to return to the main menu.
- Use the arrow keys to select "View Remaining Budget" on the main menu (so that the
-
Set Spending Limits:
- Use the arrow keys to select "Set Spending Limits" on the main menu (so that the
>is next to it). - Press Enter to proceed.
- The console will then display the "Set Spending Limits for Categories" screen, showing the current limit, amount spent, and a progress bar for each category:
Set Spending Limits for Categories > Groceries: Current Limit: $635.00 Amount Spent: $583.00 [================== ] 92% Eating Out: Current Limit: $800.00 Amount Spent: $800.00 [====================] 100% Entertainment: Current Limit: $200.00 Amount Spent: $0.00 [ ] 0% Communication: Current Limit: $800.00 Amount Spent: $10,620.00 [====================] 100% Miscellaneous: Current Limit: $200.00 Amount Spent: $0.00 [ ] 0% Back- Use the up and down arrow keys to move the
>symbol to highlight the category for which you want to set a new spending limit (e.g., "Groceries"). "Back" will take you back to the main menu. - Press Enter to select the highlighted category.
- If you select a category (e.g., "Groceries"), the application will prompt you to enter a new limit for that category:
Enter new limit for Groceries:- Type the new numerical value for the spending limit and press Enter.
- The console will then refresh, displaying the updated spending limit for the selected category in the "Set Spending Limits for Categories" screen.
- To return to the main menu, navigate to the "Back" option using the arrow keys and press Enter.
Note: The process for adding expenses to other categories (Eating Out, Entertainment, Groceries, Miscellaneous) follows the same steps: select the category, enter the amount, and confirm.
- Use the arrow keys to select "Set Spending Limits" on the main menu (so that the
-
Exit:
- Use the arrow keys to select "Exit" on the main menu (so that the
>is next to it). - Press Enter to proceed.
- The console will display a "Goodbye!" message, and the application will close:
Please choose an option: Add Expense View Remaining Budget Set Spending Limits > Exit Goodbye!- After seeing the "Goodbye!" message, you can close the terminal window.
- Use the arrow keys to select "Exit" on the main menu (so that the
- All data is stored in the
Budget.dbfile located in the application directory.
If you encounter any issues while using the application, please open an issue on the GitHub Issues page of this repository, providing details about the problem you are facing.
Thank you for using Aria's Budget Tracker!