Skip to content

Latest commit

 

History

History
105 lines (66 loc) · 3.19 KB

README.md

File metadata and controls

105 lines (66 loc) · 3.19 KB
Raw


typescript nextdotjs tailwindcss

Finan Smart

📋 Table of Contents

  1. 🤖 Introduction
  2. ⚙️ Tech Stack
  3. 🔋 Features
  4. 🤸 Quick Start
  5. 🕸️ Assets & Code
  6. 🚀 More

🤖 Introduction

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, send me a direct message in Twitter

⚙️ Tech Stack

  • Next.js
  • TypeScript
  • OpenAI API
  • Tailwind CSS

🔋 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 OpenAI's GPT-4 model.

👉 Responsive Design: Ensures a seamless experience across different devices.

🤸 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:

Cloning the Repository

git clone https://github.com/bouzayenilyes/ai-finance-tracking.git
cd ai-finance-tracking

Installation

Install the project dependencies using npm:

npm install

Set Up Environment Variables

Create a new file named .env in the root of your project and add the following content:

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.

Running the Project

npm run dev

Open http://localhost:3000 in your browser to view the project.