Skip to content

mlim70/FinCompare-Combined

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Financial Learning & Analysis Platform

Our website is designed to make learning and utilizing financial statements both easy and fun.

📌 Problem Statement

Balance sheets and income statements are essential for understanding a company’s financial health. However, many employees struggle with financial interpretation, leading them to avoid reviewing these documents. Our platform simplifies the process by offering two core features: an interactive analysis tool and a guided learning experience, helping users become proficient in financial analysis with ease.

⭐ Key Features

1. Analysis Tool

  • Drag & Drop Interface

    Easily input key financial statement data, such as balance sheets and income statements, via CSV or Excel files. If the file is not in one of these formats, it will be assumed to be an image.

  • Visual Data Generation

    Automatically convert your data into visual charts and graphs that highlight essential financial metrics.

  • Comparative Analysis

    Quickly and intuitively compare data across different periods or categories to support informed decision-making.

2. Interactive Learning Game

  • Foundational Concept Learning

    Learn the basics of balance sheets and financial metrics through a variety of interactive challenges.

  • Game-Based Learning

    Designed with beginners in mind, our engaging and interactive game maximizes your learning experience.

🚀 Setting Up UgaHacks & FinCompare

Follow these steps to get everything running smoothly!

  1. ** Clone & Run the Frontend**
git clone https://github.com/lukasp-dev/ugaHacks.git
cd ugaHacks
npm i
npm run dev

Your frontend will be live at http://localhost:5173 🎉

  1. ** Retrieve the Secret Sauce (.env) for Backend**
    Head over to this secret vault 🔐
  • You’ll need a magic word to unlock it 🧙‍♂️
  • Think "the name of this hackathon", all lowercase 😉

Once inside, copy the .env file contents.

  1. ** Clone & Run the Backend**
git clone https://github.com/lukasp-dev/FinCompare.git
cd FinCompare
  • Create a .env file in the root directory and paste the secret contents.

Then, install dependencies & start the server:

npm i
node server.js

Your backend will be live at http://localhost:8080 🚀

🚩 Getting Started

  1. Visit the Website

    Go to [Website URL] and start exploring.

  2. Sign Up and Log In

    Register quickly and gain instant access to both the Analysis Tool and the Learning Game.

  3. Input and Analyze Data

    Use our drag & drop feature to input your financial data and experience the power of visual and comparative analysis.

  4. Upload Financial Statements

    • You can upload balance sheets and income statements for up to 5 companies. Each company can have financial data for multiple years.
    • Once an image is uploaded, the system will parse the data and auto-fill the respective fields. Users should verify that the extracted data matches their original files before proceeding.
  5. View Data Visualizations

    • After confirming the uploaded data, clicking the ‘Next’ button will generate eight different visualizations.
      • Balance Sheet Comparison: Bar chart and line chart comparing balance sheet components across companies.
      • Income Statement Comparison: Bar chart and line chart comparing income statement components across companies.
      • Balance Sheet Financial Data Analysis: Bar chart displaying balance sheet data for a single company over multiple years.
      • Income Statement Financial Data Analysis: Bar char displaying income statement data for a single company over multiple years.
      • Financial Ratios: Key calculated ratios presented per company.
      • EBITA: A dedicated chart displaying EBITDA calculations.
    • These visualizations provide users with a comprehensive financial analysis of their balance sheet and income statement data.
  6. Utilize the Learning Game

    • If interpreting the generated charts proves challenging, it may indicate a lack of foundational financial knowledge. The Learning Game helps users build this understanding.
    • Selecting the game section will present 10 randomly selected questions from the following categories.
      • Definition-based questions testing fundamental financial concepts.
      • Interpretation questions assessing the ability to analyze economic indicators.
      • Calculation questions requiring users to compute financial metrics based on given balance sheet and income statement data.
        • For this calculation-based questions, hints about relevant formulas will be provided.

🖥️ Tech Stack

🌐 Frontend

React Chart.js Vite JavaScript Axios

🛠 Backend & Database

Node.js Express.js MongoDB

☁️ Cloud & API

AWS S3 MongoDB Atlas OpenAI

🙋‍♂️ Future Steps

  1. Enhance Data Integration
    • Support additional financial statement formats such as cash flow statements.
  2. Expand Learning Game Content
    • Introduce advanced financial analysis scenarios.
    • Enhance engagement by incorporating features such as avatar customization and competitive elements among users.
  3. Introduce Collaborative Features
    • Create a discussion platform where users can engage in financial report analysis and exchange insights.

About

Top 3 winner of UGAHacks X ~ Fintech track by Truist Financial!

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors