https://github.com/waymondrang/budgetbuddy
A collection and analysis tool for UCSD HDH Account transactions
https://github.com/waymondrang/budgetbuddy
browser-extension hdh ucsd
Last synced: 7 months ago
JSON representation
A collection and analysis tool for UCSD HDH Account transactions
- Host: GitHub
- URL: https://github.com/waymondrang/budgetbuddy
- Owner: waymondrang
- Created: 2021-11-24T17:47:43.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-02T01:53:42.000Z (about 3 years ago)
- Last Synced: 2024-05-01T18:42:10.796Z (over 1 year ago)
- Topics: browser-extension, hdh, ucsd
- Language: JavaScript
- Homepage:
- Size: 2.34 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# BudgetBuddy
A browser extension for collecting and analyzing UCSD HDH Account transactions.
## Table of Contents
- [Known Issues](#known-issues)
- [How It Works](#how-it-works)
- [Installation](#installation)
- [Usage](#usage)
- [Analyze](#analyze)
- [Building From Source](#building-from-source)
## Known Issues
Please refer to the [Issues section](https://github.com/waymondrang/budget-buddy/issues) regarding any issues/bugs with BudgetBuddy.
## How It Works
As a browser extension, BudgetBuddy has permission to view information and manipulate the [eAccounts Account Transactions page](https://eacct-ucsd-sp.transactcampus.com/eAccounts/AccountTransaction.aspx). BudgetBuddy also has permission to store data locally in the browser and open new tabs. No user data, including analytics data, is sent from the extension.
## Installation
To install BudgetBuddy, either pull/clone the repository or download as .zip. If necessary, unzip the file, then navigate to the Chrome Extensions page at `chrome://extensions/`.
Once on the Chrome Extensions page, enable **Developer Mode** using the toggle on the top-right of the page, revealing a button drawer.
Select **Load Unpacked** and locate the folder with the contents of BudgetBuddy. BudgetBuddy should now appear under the list of installed extensions. Make sure that the version of your installed BudgetBuddy matches the most up to date version.
Congrats, you've installed BudgetBuddy!
## Usage
To start utilizing BudgetBuddy, navigate to the [eAccounts Account Transactions page](https://eacct-ucsd-sp.transactcampus.com/eAccounts/AccountTransaction.aspx).
Once the Account Transaction Report form appears, a separate box titled BudgetBuddy will appear under the form. Click **Start** to initiate the data collection process.
Collected transaction data is automatically saved at the end of the process
After the process finishes, two options will appear. **Launch Analyzer** will open the BudgetBuddy Analyzer page where users can visualize, sort, and filter through transactions.
## Analyze
_This section is still in progress_
## Building From Source
If you would like to build the extension from the source code yourself, navigate to `src/analysis page` and run `npm install`. After the dependencies have installed, run `npm run build`, which will build the web app into `src/extension/build`.