Skip to content

Latest commit

 

History

History
65 lines (49 loc) · 2.32 KB

README.md

File metadata and controls

65 lines (49 loc) · 2.32 KB

💸 BudgetMap 💰 (Currently Under Development)

BudgetMap is a responsive, user-friendly expense tracker web app designed to help users manage their budgets on a monthly and yearly basis. Users can track expenses, manage budgets, and visualize their savings effectively.

Features (May Change)

  • Monthly and Yearly Budgets: Manage budgets on a monthly and yearly basis.
  • Add, Update, Delete Expenses: Simple CRUD operations for managing expenses.
  • Total Monthly Budget and Savings: Track your total budget for the month and see how much you've saved.
  • Category-wise Tracking: Break down expenses into different categories for better financial insights.
  • Expense Limit Alerts: Receive alerts when nearing your expense limits.
  • Graphs & Visualizations: Get a visual breakdown of your expenses and savings.
  • Recurring Expenses: Automate recurring expenses like rent or utility bills.
  • Income Management: Track both expenses and incomes, and calculate net savings.
  • Multi-Currency Support: Handle expenses in multiple currencies with real-time conversion rates.
  • Data Export: Export expense data in CSV or PDF format.
  • Authentication: Users can sign up, log in, and manage their profiles.
  • Savings Goals: Set savings goals and track progress.

Tech Stack

Frontend

  • React: For building the user interface.
  • TypeScript: Ensures strong type safety and better development experience.
  • Tailwind CSS: For designing a responsive and modern UI.

Backend

  • Node.js: JavaScript runtime for server-side operations.
  • Express: For building RESTful APIs.

Installation

To run this project locally, follow these steps:

Backend Setup

  1. Clone the repository.

  2. Navigate to the Backend directory:

    cd Backend

  3. Install dependencies:

     npm install

  4. Create a .env file in the backend directory and add the necessary environment variables for database connections, etc.

  5. Start the server:

    npm start

Frontend Setup

  1. Navigate to the Frontend directory:

    cd Frontend

  2. Install dependencies:

     npm install

  3. Start the server:

    npm run dev

Contributions

Contributions are welcome! Please fork this repository and submit a pull request for any features or improvements.