munera-vaadin/README.md

41 lines
1.5 KiB
Markdown
Raw Normal View History

2024-05-20 22:05:38 +00:00
# Munera: Expense Tracking Application
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
## Overview
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
Munera is an application designed to help users efficiently track their expenses. The backend of the application is currently functional, allowing users to perform CRUD (Create, Read, Update, Delete) operations on expenses, creditors, debtors, and categories. The application is built on a PostgreSQL database to securely store expense-related information.
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
### 1. Expense Management
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
- Create, read, update, and delete expenses with the following details:
- Name
- Date
- Category
- Cost
- Description
- Period Interval (1, 2, 3)
- Period Unit (days, weeks, months)
- Creditors and debtors
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
## Completed Features
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
- [x] Create concept of creditors and debtors for each expense
- [x] Insert expenses of the past and of the future
- [x] Have an option to set up recurring expenses
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
## Next Steps
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
1. **Frontend Structure**
- Decide on the frontend structure, most likely a Command Line Interface (CLI).
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
2. **CLI Design**
- If a CLI is implemented, consider designing tables and a calendar view for enhanced user experience.
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
3. **Filtering and Sorting**
- Implement filtering and sorting functionalities for all major entities to enhance data organization.
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
4. **Weekly and Monthly Summaries**
- Create functionality to generate weekly and monthly summaries, including filtering and sorting options.
5. **Reports for Creditors and Debtors**
- Develop reports outlining debts or credits for each creditor and debtor to provide users with a comprehensive overview.