WalletWhiz

WalletWhiz is an Android mobile application for budget management, developed using Unity6. Designed to be open to modifications and improvements, it serves as a flexible foundation for developers who wish to customize a financial management solution. Initiated by a former student of the 42 school in Angoulême, WalletWhiz offers a user-friendly and intuitive experience for managing personal finances.

Key Features

WalletWhiz stands out with its intuitive interface and comprehensive features for efficient budget management. Here are the app's main capabilities:

Track Current Balance and Forecasts: Displays your current balance in real-time and provides an end-of-month forecast.
Transaction Input: Allows you to add expenses and income with recurrence options (monthly, daily, etc.) and descriptions.
Transaction Management: Displays a list of recorded transactions, including details such as amounts, recurrence dates, and associated categories.
Customizable Categories: Create, modify, or delete categories to tailor the app to your needs.
Reports and Statistics: Provides charts and summaries to analyze your expenses and income by period and category.

Note: The application is currently available only in French.

Installation and Setup

To install and run WalletWhiz, follow the steps below:

Prerequisites

Unity6 installed on your machine.
An Android device for testing the application.
Git for cloning the repository.

Installation Steps

Clone the repository from GitHub:

git clone https://github.com/username/WalletWhiz.git

Open the project in Unity6.
Ensure all dependencies are installed via the Unity Package Manager.
Configure an Android device for development (enable debugging mode).
Build and deploy the project by following Unity's Android deployment instructions.

User Guide

First Launch: After installing the app, open WalletWhiz to access the main screen displaying your current balance and forecasts.
Add Transactions: Tap the transaction entry icon to add an expense or income. Fill in the required fields (amount, category, date, etc.).
View Transactions: Navigate to the transaction management section to view your recorded entries.
Customize Categories: In the "Categories" section, add or modify categories based on your preferences.
View Reports: Go to "Reports & Statistics" to access charts showing your finances by period and category.

Contribution

WalletWhiz is an open-source project, and contributions are welcome! Here’s how to get involved:

Contribution Workflow

Fork the repository.
Create a branch for your feature or bug fix:
```
git checkout -b feature/your_feature_name
```
Make your changes and commit them:
```
git commit -m "Added [feature/fix]"
```

Push your changes:

git push origin feature/your_feature_name

Open a pull request on GitHub.

Contribution Guidelines

Ensure your code is well-documented.
Perform thorough testing before submitting a pull request.
Adhere to the project’s coding conventions.

License and Legal Information

WalletWhiz is distributed under the MIT License. You are free to use, modify, and redistribute the project within the terms of this license.

Support and Contact

For questions or assistance, please open an issue on GitHub or contact the development team at the following email address: support@walletwhiz.com.

Acknowledgments and Credits

A big thank you to all contributors and users of WalletWhiz. Your support is essential to the success of this project.

Inspired by the passion and dedication of a former student of the 42 school in Angoulême, WalletWhiz is designed to be a useful and scalable solution for budget management.

Timocaa/WalletWhiz