310A1BudgetTracker
The Budget Tracker is a user-friendly desktop application designed to help you manage your personal finances effectively to enhance your financial awareness and to promote healthy spending habits.
Managing personal finances is important to ensure financial stability, making informed decisions, and work towards financial goals. However, many people lack the knowledge on how to do it and are unable to achieve finanical freedom. The Budget Tracker application aims to streamline the process of managing your finances so that you'll gain a better perspective of where and how you’re spending your money, empowering you to have financial control and work towards your financial goals.
NOTE: This project is associated with the University of Auckland SOFTENG 310.
Getting Started
Prerequisites
Before you begin, ensure you have the following prerequisites:
The Maven setup in this project should install JavaFX for you.
Installation
- Configure the JAVA_HOME environment variable by following the instructions here. Afterwards, verify if the JAVA_HOME environment variable is properly set by navigating to your Terminal and typing the following:
java -version - Once verified, clone the repository to your directory of choice:
git clone https://github.com/nathanbell806/310A1BudgetTracker - Done!
Running
Unix/MacOsX:
./mvnw clean javafx:run
Windows:
.\mvnw.cmd clean javafx:run
Testing
Unix/MacOsX:
./mvnw clean test
Windows:
.\mvnw.cmd clean test
License
This software is distributed under the MIT License.
Copyright (c) 2023 Budget Tracker
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Help
If you require additional assistance or have any questions, you can:
- Check out the Issues section on GitHub to first see if the issue has already been addressed to avoid duplicate issues. Otherwise, you can open a new issue.
Contributing Guidelines
If you're interested in contributing to the project, please read our Contributing Guidelines.