https://github.com/dev-emekaa/pennysmart
AI-driven financial manager, offering personalized budgeting and expense tracking solutions to improve financial management.
https://github.com/dev-emekaa/pennysmart
clerk-auth gemini-ai javascript nextjs shadcn-ui tailwind-css
Last synced: 3 months ago
JSON representation
AI-driven financial manager, offering personalized budgeting and expense tracking solutions to improve financial management.
- Host: GitHub
- URL: https://github.com/dev-emekaa/pennysmart
- Owner: dev-emekaa
- Created: 2024-09-29T14:16:49.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-20T18:43:52.000Z (about 1 year ago)
- Last Synced: 2025-10-28T20:39:13.700Z (7 months ago)
- Topics: clerk-auth, gemini-ai, javascript, nextjs, shadcn-ui, tailwind-css
- Language: JavaScript
- Homepage: https://www.pennysm.art
- Size: 2.17 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
PennySmart
AI Personal Finance Assistant with Expense Tracking, Budget Planning, and Personalised Financial Insights.
## 📋 Table of Contents
1. [About](#about)
2. [Tech Stack](#tech-stack)
3. [Features](#features)
4. [Quick Start](#quick-start)
## About
PennySmart is the AI personal financial assistant you most certainly need. It helps you track your spending, stick to your budgets, set and reach your financial goals, as well as get personalized insights to help you make better financial decisions.
## Tech Stack
- Next.js
- JavaScript
- Google GEMINI-AI API
- Tailwind CSS
- Shadcn-ui
## Features
- **Income and Expense Input**: Allows users to input their income and expenses.
- **Budget Management**: Enables users to manage their budgets effectively.
- **Personalized Financial Advice**: Provides detailed financial advice based on user-specific financial data using Googles GEMINI-AI API.
- **Data Visualisation and Metrics**: Provides various financial metrics like total income, expenses, budget amount and also provides an Interactive Chart for better visualisation of users Financial Data.
## Quick Start
Follow these steps to set up the project locally on your machine.
**Prerequisites**
Make sure you have the following installed on your machine:
- [Git](https://git-scm.com/)
- [Node.js](https://nodejs.org/en)
- [npm](https://www.npmjs.com/) (Node Package Manager)
**Cloning the Repository**
```bash
git clone https://github.com/dev-emekaa/PennySmart.git
cd PennySmart
```
**Installation**
Install the project dependencies using npm:
```bash
npm install
```
**Set Up Environment Variables**
Create a new file named `.env` in the root of your project and add the following content:
```env
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=
CLERK_SECRET_KEY=
NEXT_PUBLIC_CLERK_SIGN_IN_URL=
NEXT_PUBLIC_CLERK_SIGN_UP_URL=
NEXT_PUBLIC_GOOGLE_GEMINIAI_API_KEY=
NEXT_PUBLIC_DATABASE_URL=
```
**Running the Project**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.