Skip to content

A comprehensive budgeting and financial management tool for individuals and businesses.

License

Notifications You must be signed in to change notification settings

shyke0611/FinTrack

 
 

Repository files navigation

GitHub forks GitHub issues GitHub contributors Contributor Guidelines Code of Conduct MIT License Wiki


FinTrack

Budgeting and Financial Management Tool


View Demo · Report Bug · Request Feature · Request Documention


Table of Contents
  1. Project Insight
  2. About The Project
  3. Getting Started
  4. Versions
  5. Contributing
  6. License
  7. Contacts
  8. Acknowledgments

Project Insight

Alt

(back to top)

About The Project

FinTrack is designed to be a comprehensive financial management tool aimed at helping users gain better control over their finances. Whether for personal use or business purposes, FinTrack provides a robust platform for tracking income, expenses, and budgets. The tool is built with a focus on user-friendly data visualisation and forecasting features, ensuring users can easily interpret their financial data and make informed decisions. You can read more at Project Description about the next steps!

This project has been deployed to Render, a free hosting service that provides automated builds and deployments. The application is configured to automatically rebuild and redeploy whenever there is a merge to the main branch. This ensures that the latest changes are always reflected in the live environment without any manual intervention. You can access the live application by clicking View Demo. If you encounter an issue, please contact us at Contacts

Important Note: As this application is hosted on a free service, the demo may take up to 50 seconds to respond if it has been inactive. This is due to the hosting service temporarily pausing the application to save resources. Thank you for your patience!

Make sure to contact us at Contacts for the database variables to store in your environment variables.

(back to top)

What does this project do?

FinTrack empowers users to efficiently manage their financial activities. It enables users to create and maintain personal or business financial profiles, categorize and monitor expenses, set and adhere to budgets, and forecast both income and asset values. Additionally, FinTrack offers goal-setting and tracking features, allowing users to achieve their financial objectives with ease.

(back to top)

Why is this project useful?

FinTrack is useful because it provides a centralized platform for managing and optimizing financial resources, making it easier for individuals and businesses to track their financial health. By offering features such as expense categorization, budget monitoring, and income forecasting, it helps users make informed financial decisions, avoid overspending, and achieve their financial goals. The data visualization tools further enhance the user experience by presenting complex financial data in an easy-to-understand format, making financial management more accessible and efficient.

(back to top)

Tech Stack Used

  • Vaadin
  • Spring Boot
  • CSS
  • Java

(back to top)

Getting Started

Prerequisites

You will need the following software installed:

To set up Maven:

Installation

  1. Fork the Repo: Click the "Fork" button at the top right of the repository page to fork the project to your GitHub account.

  2. Clone the Forked Repo using Terminal/Command Prompt: Replace your-username with your GitHub username.

    git clone https://github.com/your-username/FinTrack.git
  3. Navigate to the Project Directory:

    cd FinTrack
  4. Update application.properties under resources:

    Before running the application locally, make sure to set Vaadin to development mode by updating the application.properties file.

    vaadin.productionMode=false

    Note: When you push your changes to the repository, remember to change vaadin.productionMode back to true to enable production mode.

  5. Install Maven Dependencies:

    mvn clean install
  6. Run the Project:

    mvn clean spring-boot:run 

Alternatively, you can open Application.java in your IDE (such as IntelliJ IDEA or VS Code) and press the "Run" button to start the application. Once the application is running, your web browser should open automatically. If not, open a new browser window and type http://localhost:8080 to access the application.

(back to top)

Versions

Fintrack v1.0.0

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please read more at Contributor Guidelines

License

Distributed under the MIT License. Read more at MIT License for more information.

(back to top)

Contacts

If you have any inquiries related to this project or face any issues contact us using the information below:

Email: hshi270@aucklanduni.ac.nz Email: sdes755@aucklanduni.ac.nz Email: sbha878@aucklanduni.ac.nz Email: srab017@aucklanduni.ac.nz Email: jman988@aucklanduni.ac.nz

(back to top)

Acknowledgments

(back to top)

About

A comprehensive budgeting and financial management tool for individuals and businesses.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 95.4%
  • Java 3.3%
  • TypeScript 1.1%
  • Other 0.2%