diff --git a/README.md b/README.md new file mode 100644 index 0000000..e66e0b0 --- /dev/null +++ b/README.md @@ -0,0 +1,76 @@ +# Personal Finance Tracker + +A comprehensive web-based personal finance management application that helps users track their finances, manage accounts, analyze spending patterns, and monitor investments. + +## Features + +- **Dashboard**: Get a quick overview of your financial health +- **Accounts Management**: Track multiple bank accounts and their balances +- **Transactions**: Record and categorize income and expenses +- **Investments**: Monitor your investment portfolio +- **Liabilities**: Keep track of loans and debts +- **Analytics**: Visualize your financial data through charts and graphs +- **Profile Management**: Manage your user profile and preferences + +## Tech Stack + +- HTML5 +- CSS3 (with responsive design) +- Vanilla JavaScript (ES6+) +- Modular architecture for better code organization + +## Project Structure + +``` +├── index.html # Main entry point +├── css/ # Stylesheets +│ ├── accounts.css +│ ├── analytics.css +│ ├── auth.css +│ ├── base.css +│ ├── components.css +│ ├── dashboard.css +│ └── ... +└── js/ # JavaScript modules + ├── main.js + └── modules/ + ├── accounts.js + ├── analytics.js + ├── auth.js + └── ... +``` + +## Getting Started + +1. Clone the repository +```bash +git clone https://github.com/Lalith0024/personal-finance-tracker-lalith.git +``` + +2. Open the project directory +```bash +cd personal-finance-tracker-lalith +``` + +3. Open `index.html` in your web browser or use a local development server + +## Usage + +1. Create an account or log in +2. Add your bank accounts and initial balances +3. Start tracking your transactions +4. Use the analytics dashboard to visualize your spending patterns +5. Monitor your investments and liabilities +6. Update your profile settings as needed + +## Contributing + +1. Fork the repository +2. Create your feature branch (`git checkout -b feature/amazing-feature`) +3. Commit your changes (`git commit -m 'Add some amazing feature'`) +4. Push to the branch (`git push origin feature/amazing-feature`) +5. Open a Pull Request + +## License + +This project is licensed under the MIT License.