Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.7 KB

README.md

File metadata and controls

71 lines (46 loc) · 2.7 KB
Raw

BudgetMe!

A simple, mobile-friendly budget tracker web application hosted on GitHub Pages. This app allows users to track their income and expenses, set budget goals, and visualize their financial data.

Features

  • Transaction Management: Add, view, and manage financial transactions
  • Customizable Categories: Create, edit, and delete transaction categories
  • Budget Goals: Set and monitor progress towards financial goals
  • Recurring Transactions: Set up and manage recurring income or expenses
  • Search and Filter: Easily find and organize your transactions
  • Data Visualization: Visual representations of your financial data using charts
  • Export: Backup your data in CSV format
  • Offline Functionality: Full app functionality even without an internet connection
  • Mobile-Friendly: Responsive design for a seamless experience on all devices
  • PWA: Install as a standalone app on your device

Technologies Used

  • HTML5
  • CSS3
  • JavaScript (ES6+)
  • Chart.js for data visualization
  • LocalStorage for data persistence
  • Service Workers for offline functionality

Usage

  1. Adding Transactions: Use the form at the top of the page to add new transactions. Fill in the description, amount, date, category, and currency.

  2. Managing Categories: Scroll down to the "Manage Categories" section to add, view, or delete transaction categories.

  3. Setting Budget Goals: Enter your budget goal in the designated input field and click "Set Goal" to track your progress.

  4. Searching and Filtering: Use the search bar to find specific transactions, or use the category filter to view transactions by category.

  5. Viewing Charts: Scroll down to see visual representations of your spending habits and trends.

  6. Exporting Data: Use the "Export Data" button to download your data

Offline Usage

As a PWA, this app can be installed on your device and used offline:

  1. Open the app in Chrome on your device.
  2. Click the "Add to Home Screen" prompt, or select "Install" from the browser menu.
  3. The app will now be available as a standalone application on your device.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the project
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

This project is open source and available under the MIT License.

Acknowledgements