munera-vaadin/README.md

62 lines
2.6 KiB
Markdown
Raw Permalink 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-23 22:12:12 +00:00
Munera is a companion for managing expenses efficiently and effortlessly, whether you're tracking daily expenditures, managing recurring expenses, or keeping tabs on creditors and debtors.
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
2024-05-23 22:12:12 +00:00
- Period Interval (1, 2, 3, etc)
2024-05-20 22:05:38 +00:00
- Period Unit (days, weeks, months)
- Creditors and debtors
2024-07-07 15:57:21 +00:00
- Status
2024-05-23 22:12:12 +00:00
-
- Create, read, update and delete categories
2024-06-11 19:13:38 +00:00
- Create, read, update and delete people
2024-07-07 15:57:21 +00:00
- Create, read, update and delete events
2024-05-18 14:42:12 +00:00
2024-05-20 22:05:38 +00:00
## Completed Features
2024-05-23 22:12:12 +00:00
- [x] Create categories with CRUD operations
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-06-04 12:35:22 +00:00
- [x] Creditors and debtors total expenses
2024-07-07 15:57:21 +00:00
- [x] Setup status for each expense
- [x] Create mechanism to change status when expense gets paid
- [x] Create labels to show if a person is in debit or credit with you
- [x] First tries with widgets in a dashboard view
- [x] An expense cant have the same person as both creditor and debtors
2024-05-20 22:05:38 +00:00
## Next Steps
2024-05-18 14:42:12 +00:00
2024-05-23 22:12:12 +00:00
1. **Filtering and Sorting**
2024-07-07 15:57:21 +00:00
- Keep implementing sorting on more columns, start implementing filtering
2024-05-23 22:12:12 +00:00
2. **Weekly and Monthly Summaries**
2024-05-20 22:05:38 +00:00
- Create functionality to generate weekly and monthly summaries, including filtering and sorting options.
2024-07-07 15:57:21 +00:00
~~- Create a dashboard or log of "next expenses" that lists the next recurring expenses that you expect to receive~~
2024-05-20 22:05:38 +00:00
2024-05-23 22:12:12 +00:00
3. **Reports for Creditors and Debtors**
2024-07-07 15:57:21 +00:00
~~- Develop reports outlining debts or credits for each creditor and debtor to provide users with a comprehensive overview.~~
~~- CRUD operations for creditors and debtors~~
2024-05-25 13:56:18 +00:00
2024-06-04 12:35:22 +00:00
4. **Create a way to set the currency of each expense**
- It should be possible in the form of an expense
- The symbol should be added to the cost column
- If possible, the calculations should take into account the different currencies
2024-06-11 19:13:38 +00:00
5. **Events**
2024-07-07 15:57:21 +00:00
~~- Options to create events in which to put expenses (vacations, congress, etc)~~
~~- Each event has a number of people connected to it, expenses can be added to these people~~
2024-06-11 19:13:38 +00:00
- A reports tells which people need to give/take money to which people in order to be even
2024-05-25 13:56:18 +00:00
## Known Issues
2024-06-04 12:35:22 +00:00
- Form still needs more validation when empty, some entities can be created with all null values, even the ones that have constraints throw SQL errors, they need to be gracefully handled.
2024-07-07 15:57:21 +00:00
- Graphs still need a lot of improvements
- PeriodUnit and Interval need to be implemented