Skip to content

Latest commit

 

History

History
115 lines (76 loc) · 2.89 KB

README.md

File metadata and controls

115 lines (76 loc) · 2.89 KB
Raw

BudgetBuddy

BudgetBuddy is a personal finance tracker that helps users manage expenses and savings effectively. Built with modern web technologies, it offers a seamless experience for tracking financial transactions and generating insightful reports.

Features

  • Expense Tracking: Log daily expenses and categorize them for easy management.
  • Savings Goals: Set and track savings goals with real-time updates.
  • Data Visualization: Interactive charts and graphs to visualize your financial data.
  • Secure Authentication: User accounts secured with Clerk authentication.

Tech Stack

  • Frontend: Next.js, Shadcn/ui, React, TypeScript
  • State Management: React Query
  • Backend: Prisma, PostgreSQL
  • Authentication: Clerk
  • Visualization: Recharts

Getting Started

Prerequisites

Ensure you have the following installed:

  • Node.js (v14.x or later)
  • npm or yarn
  • PostgreSQL (v12.x or later)

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/BudgetBuddy.git
cd BudgetBuddy

  2. Install dependencies:

    Using npm:

    npm install

    Using yarn:

    yarn install

  3. Setup the environment variables:

    Create a .env file in the root directory and add the following:

    DATABASE_URL=postgresql://username:password@localhost:5432/budgetbuddy
NEXT_PUBLIC_CLERK_FRONTEND_API=<your_clerk_frontend_api>
CLERK_API_KEY=<your_clerk_api_key>

    Replace the placeholders with your PostgreSQL and Clerk credentials.

  4. Migrate the database:

    npx prisma migrate dev

  5. Run the development server:

    npm run dev

    or

    yarn dev

    Your app should now be running on http://localhost:3000.

Usage

  • Add Transactions: Navigate to the "Transactions" page to log new expenses or income.
  • View Reports: Use the "Reports" page to visualize your spending and savings trends.
  • Manage Account: Access the "Account" page to update your profile and manage your budget.

Contributing

We welcome contributions! Please follow these steps:

  1. Fork the repository.
  2. Create a new branch: git checkout -b feature-branch-name
  3. Make your changes and commit: git commit -m 'Add some feature'
  4. Push to the branch: git push origin feature-branch-name
  5. Submit a pull request.

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contact

Connect with me on social media:

Feel free to reach out if you have questions, suggestions, or just want to chat about BudgetBuddy

Happy coding! 🚀