Files
Fin-Track/README.md

54 lines
1.4 KiB
Markdown
Raw Normal View History

2025-09-23 10:48:15 -06:00
# Fin Track
2025-04-15 20:00:16 -06:00
2026-02-20 22:05:31 -07:00
<img class="fullimage" alt="Fin-Track Application Screenshot" src="./assets/Fin-Track.gif" style="width:95%;" />
2026-02-20 22:04:39 -07:00
2025-09-23 10:48:15 -06:00
Fin Track is a financial tracking application that helps users stay on top of their banking information at a glance. With a physical display showing real-time bank status, balance, transactions, and savings, users can keep their finances always visible. Additionally, the app allows users to set reminders for recurring payments and engage in interactive quizzes to enhance their financial literacy.
2026-02-20 22:04:39 -07:00
2026-02-20 22:05:31 -07:00
<img class='fullimage' alt='Fin-Track Application DemoImage' src='./assets/Hardware.JPG'/>
2025-02-16 10:17:17 -07:00
## How to Run
### 1. Clone the Repository
```bash
2025-02-16 15:46:34 -07:00
git clone https://github.com/mannpatel0/fin-track.git
2025-02-16 10:17:17 -07:00
cd fin-track
```
### 2. Backend Setup
1. Navigate to the backend folder:
```bash
cd backend
```
2. Install dependencies:
```bash
npm install
```
3. Run the backend server:
```bash
node index.js
```
### 3. Frontend Setup
1. Navigate to the frontend folder:
```bash
cd frontend
```
2. Install dependencies:
```bash
npm install
```
3. Run the frontend:
```bash
npm run dev
```
### 4. Setting Up the Physical Display (Arduino)
2025-02-26 20:39:09 -07:00
1. Connect the Arduino to the computer.
2025-02-16 10:17:17 -07:00
2. Open `fintrack_display.ino` in Arduino IDE.
3. Upload the script to the Arduino board.
2025-02-26 20:39:09 -07:00
4. Run the display API:
2025-02-16 10:17:17 -07:00
```bash
python3 Display_API.py
```