Skip to content

Latest commit

 

History

History
83 lines (64 loc) · 3.39 KB

README.md

File metadata and controls

83 lines (64 loc) · 3.39 KB

Here’s a revised and expanded version of your README for the Spendy Tracker project:

Spendy Tracker

Spendy Tracker is a web application designed to simplify personal finance management. It helps users effectively track their income and expenses, providing an intuitive and efficient way to manage their budget. Built using PHP, Laravel, HTML, CSS, JavaScript, Vue.js, and MySQL, Spendy Tracker offers a reliable, user-friendly platform to monitor financial activities and keep track of budgeting goals.

Table of Contents

Introduction

Spendy Tracker was created to assist users in managing their financial transactions by allowing them to track monthly income and expenses, categorize expenses, and perform basic CRUD operations on their financial data. With this platform, users can organize and assess their spending habits to make better-informed budgeting decisions.

Features

  • Income and Expense Tracking: Easily track your income and expenses to understand your financial flow.
  • Expense Categorization: Link your expenses to categories for better organization and clearer insights.
  • CRUD Operations: Perform create, read, update, and delete operations on your income, expenses, and categories.
  • User-friendly Interface: An intuitive and simple user interface designed to provide a seamless experience.
  • Data Persistence: All information is stored securely in a MySQL database, ensuring that your data is safe and easily retrievable.

Installation

To set up Spendy Tracker on your local machine, follow these steps:

  1. Clone the repository:

    git clone https://github.com/AhmedGamal905/SpendyTracker
cd SpendyTracker

  2. Install PHP dependencies:

    composer install

  3. Set up environment variables:

    • Create a .env file in the root directory if it doesn’t exist already.
    • Add the necessary configuration values for your environment.

  4. Configure the database in the .env file:

    DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=spendytracker
DB_USERNAME=root
DB_PASSWORD=

  5. Run migrations and seed the database:

    php artisan migrate --seed

  6. Start the development server:

    php artisan serve
npm run dev

Once the server is up and running, you can access the application by navigating to http://localhost:8000 in your web browser.

Usage

After setting up the project and starting the development server, users can access the dashboard and begin adding their income and expenses. Key actions include:

  • Creating Income and Expense Entries: Add your monthly income and expense entries with ease.
  • Categorizing Expenses: Link each expense to a category to better understand your spending patterns.
  • Managing Categories: Update or delete categories as needed for more accurate expense tracking.

Contributing

Contributions to Spendy Tracker are welcome! If you would like to contribute, please follow these steps:

  1. Fork the repository.
  2. Create a new branch for your feature or fix.
  3. Implement your changes.
  4. Test thoroughly to ensure functionality.
  5. Submit a pull request.

We appreciate your contributions and will review them as soon as possible.