https://github.com/khaledashrafh/fintracker
FinTracker is a command-line application designed to empower you with control over your finances. It streamlines the process of recording, tracking, and analyzing your financial transactions, providing valuable insights into your spending habits.
https://github.com/khaledashrafh/fintracker
cmd command-line command-line-application financial fintech java management personal-finances tracker tracker-application tracking transaction transaction-management
Last synced: about 2 months ago
JSON representation
FinTracker is a command-line application designed to empower you with control over your finances. It streamlines the process of recording, tracking, and analyzing your financial transactions, providing valuable insights into your spending habits.
- Host: GitHub
- URL: https://github.com/khaledashrafh/fintracker
- Owner: KhaledAshrafH
- License: mit
- Created: 2024-08-20T22:36:17.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-09-04T00:52:28.000Z (8 months ago)
- Last Synced: 2025-02-02T07:28:18.593Z (3 months ago)
- Topics: cmd, command-line, command-line-application, financial, fintech, java, management, personal-finances, tracker, tracker-application, tracking, transaction, transaction-management
- Language: Java
- Homepage:
- Size: 14.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# FinTracker
## Introduction
FinTracker is a command-line application designed to empower you with control over your finances. It streamlines the process of recording, tracking, and analyzing your financial transactions, providing valuable insights into your spending habits.
## Key Features
- **Transaction Management:** Effortlessly add new transactions with descriptions, amounts (positive for income, negative for expenses), and categories.
- **Historical Record:** Maintain a historical record of all your transactions for easy reference.
- **Transaction Viewing:** Display a clear and concise list of all your transactions, formatted for readability.
- **Sorting Options:** Optionally sort transactions by amount to prioritize transactions.
- **Financial Summary:** Gain a quick overview of your financial health with a comprehensive summary including total income, total expenses, and current balance.
- **Spending Insights:** Delve deeper into your spending patterns with detailed category-based insights to optimize your spending.
## Getting Started
### Prerequisites
- Java Development Kit (JDK) version 8 or later [Download JDK](https://www.oracle.com/java/technologies/javase-downloads.html)
- A text editor or IDE of your choice (e.g., Notepad++, Visual Studio Code)
### Cloning the Repository
Use Git to clone this repository to your local machine:
```bash
git clone https://github.com/KhaledAshrafH/FinTracker.git
```
### Compiling and Running
1- Navigate to the FinTracker directory using your terminal or command prompt.
2- Compile the Java code:
```bash
javac Main.java
```
2- Run the application:
```bash
java Main
```
## Using FinTracker
The application presents a user-friendly menu that guides you through various functionalities:
- **Input Transactions**: Add new transactions by entering a description, amount, and category.
- **View Transactions**: Display a list of all transactions, with the option to sort them by amount.
- **View Summary**: Get a summary of your total income, total expenses, and current balance.
- **Get Insights**: Analyze your spending patterns by category to understand where your money is going.
- **Exit**: Close the application.
## Example Workflow
1. Add a transaction (e.g., description: "Dinner", amount: "-30.00", category: "Food").
2. View transactions (optional: sort by amount).
3. Review your financial summary (income, expenses, balance).
4. Gain insights into your spending by category (identify areas for potential optimization).
5. Exit the application when you're finished.
## Future Enhancements
- **Persistence**: Implement data persistence to save transactions across application sessions.
- **Budgeting**: Introduce budgeting features to set spending goals and track progress.
- **Visualization**: Explore graphical visualizations to depict financial data more intuitively.
- **Search and Filtering**: Allow users to search for specific transactions or filter based on criteria.
- **Multi-Currency Support**: Expand functionality to handle transactions in multiple currencies.
## Contribution
We welcome contributions to improve FinTracker. Feel free to fork the repository, make changes, and submit pull requests. Please adhere to our coding style guidelines (if any) and provide clear documentation for your modifications.
## License
This project is licensed under the MIT [LICENSE](LICENSE). You are free to use, modify, and distribute the code under the terms of this license.
## Contact
For questions, feedback, or suggestions regarding PetPal Simulation, please contact me at [email protected].