https://github.com/arislooi/goaldigits
GoalDigits is a personal finance management application that helps users set goals, track expenses and incomes, and visualize their financial data through charts.
https://github.com/arislooi/goaldigits
budgeting-application chartjs firebase openai-api personal-finance-planner react tailwindcss webspeech-api
Last synced: 2 months ago
JSON representation
GoalDigits is a personal finance management application that helps users set goals, track expenses and incomes, and visualize their financial data through charts.
- Host: GitHub
- URL: https://github.com/arislooi/goaldigits
- Owner: ArisLooi
- Created: 2025-01-15T11:21:35.000Z (4 months ago)
- Default Branch: v0.2.2
- Last Pushed: 2025-02-20T07:49:03.000Z (3 months ago)
- Last Synced: 2025-02-20T08:31:37.207Z (3 months ago)
- Topics: budgeting-application, chartjs, firebase, openai-api, personal-finance-planner, react, tailwindcss, webspeech-api
- Language: JavaScript
- Homepage: https://goaldigits.vercel.app
- Size: 224 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GoalDigits
GoalDigits is a financial tracking application built with React, Redux, and Firebase. It enables users to set goals, track their transactions, and see progress. The app features user authentication, responsive design, dark mode, voice powered and an integrated chatbot for assistance.
## Features
- User Authentication
- Set Financial Goals
- Track Transactions
- View Progress Reports
- Responsive Design
- Dark Mode
- Voice Powered (in Chrome browser)
- Integrated Chatbot
## Technologies Used
- React
- Redux
- Firebase
- Tailwind CSS
- Node js
- React Router
- react-icons
- Firebase
- OpenAI API
- Web Speech API
- NeonDB
## Getting Started
### Prerequisites
- Node.js
- Firebase account
### Installation
1. Clone the repository:
```bash
git clone https://github.com/ArisLooi/GoalDigits.git
```
2. Navigate to the project directory:
```bash
cd GoalDigits
```
3. Install dependencies:
```bash
npm install
```
4. Create a `.env` file and add your Firebase and OpenAI API keys:
```env
VITE_BACKEND=your_backend_url
VITE_FIREBASE_API_KEY=your_firebase_api_key
VITE_OPENAI_API_KEY=your_openai_api_key
```
5. Start the development server:
```bash
npm run dev
```
## Usage
### Authentication
Users must register and log in to access features such as setting goals, tracking transactions, and viewing progress.
### Setting Goals
Navigate to the "Set Goals" page to define your financial goals.
### Tracking Transactions
Navigate to the "Keep Track" page to log your transactions.
### Viewing Progress
Navigate to the "See Progress" page to view your financial progress reports.
### Chatbot Assistance
Click the chatbot icon to get assistance from the integrated chatbot.
## Contributing
Contributions are welcome! Please fork the repository and create a pull request with your changes.
## Acknowledgements
Special thanks to:
- **Safa Yousif** - Sigma School Instructor
- **Chan Ken Jin** - Education Manager
- **Khant Linn Tun** - Mentor & Teaching Assistant
- **Jun Heng** - Teaching Assistant