https://github.com/killercavin/ai-finance-manager
https://github.com/killercavin/ai-finance-manager
Last synced: 10 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/killercavin/ai-finance-manager
- Owner: Killercavin
- Created: 2024-08-25T23:18:59.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-25T23:51:03.000Z (almost 2 years ago)
- Last Synced: 2025-03-17T05:19:33.463Z (about 1 year ago)
- Language: JavaScript
- Size: 183 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Finan Smart
Build this project step by step with our detailed tutorial on Your YouTube Channel. Join the community!
## π Table of Contents
1. π€ [Introduction](#introduction)
2. βοΈ [Tech Stack](#tech-stack)
3. π [Features](#features)
4. π€Έ [Quick Start](#quick-start)
5. πΈοΈ [Assets & Code](#snippets)
6. π [More](#more)
## π¨ Tutorial
This repository contains the code corresponding to an in-depth tutorial available on our YouTube channel, Code with Albert.
If you prefer visual learning, this is the perfect resource for you. Follow our tutorial to learn how to build projects like these step-by-step in a beginner-friendly manner!
Built with the latest Next.js and TypeScript, Finan Smart is an advanced AI financial advice tool. It allows users to input their income, expenses, and budgets, and receive personalized financial advice based on their financial data. This project is perfect for those looking to learn how to integrate AI-driven insights and financial management into a Next.js application.
If you're getting started and need assistance or face any bugs, join our active Discord community. It's a place where people help each other out.
- Next.js
- TypeScript
- OpenAI API
- Tailwind CSS
π **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 OpenAI's GPT-4 model.
π **Responsive Design**: Ensures a seamless experience across different devices.
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/Killercavin/ai-finance-manager.git
cd ai-finance-manager
```
**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=p
CLERK_SECRET_KEY=
NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in
NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up
NEXT_PUBLIC_CLERK_AFTER_SIGN_IN_URL=/
NEXT_PUBLIC_CLERK_AFTER_SIGN_UP_URL=/
NEXT_PUBLIC_OPENAI_API_KEY=
NEXT_PUBLIC_DATABASE_URL=
```
Replace the placeholder values with your actual OpenAI credentials. You can obtain these credentials by signing up on the [OpenAI website](https://openai.com/).
**Running the Project**
```bash
npm run dev
```
Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.
The repository includes all the assets and code you need to get started with Finan Smart. Follow along with our YouTube tutorial for a step-by-step guide.
## π More
For more information and additional resources, check out our YouTube channel and join our Discord community for support and discussions.