docs: README.md
This commit is contained in:
parent
8e5ba1bb2b
commit
c720e14577
1 changed files with 16 additions and 10 deletions
26
README.md
26
README.md
|
@ -15,9 +15,11 @@ Munera is a companion for managing expenses efficiently and effortlessly, whethe
|
||||||
- Period Interval (1, 2, 3, etc)
|
- Period Interval (1, 2, 3, etc)
|
||||||
- Period Unit (days, weeks, months)
|
- Period Unit (days, weeks, months)
|
||||||
- Creditors and debtors
|
- Creditors and debtors
|
||||||
|
- Status
|
||||||
-
|
-
|
||||||
- Create, read, update and delete categories
|
- Create, read, update and delete categories
|
||||||
- Create, read, update and delete people
|
- Create, read, update and delete people
|
||||||
|
- Create, read, update and delete events
|
||||||
|
|
||||||
## Completed Features
|
## Completed Features
|
||||||
- [x] Create categories with CRUD operations
|
- [x] Create categories with CRUD operations
|
||||||
|
@ -25,19 +27,23 @@ Munera is a companion for managing expenses efficiently and effortlessly, whethe
|
||||||
- [x] Insert expenses of the past and of the future
|
- [x] Insert expenses of the past and of the future
|
||||||
- [x] Have an option to set up recurring expenses
|
- [x] Have an option to set up recurring expenses
|
||||||
- [x] Creditors and debtors total expenses
|
- [x] Creditors and debtors total expenses
|
||||||
|
- [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
|
||||||
## Next Steps
|
## Next Steps
|
||||||
|
|
||||||
1. **Filtering and Sorting**
|
1. **Filtering and Sorting**
|
||||||
- Implement filtering and sorting functionalities for all major entities to enhance data organization.
|
- Keep implementing sorting on more columns, start implementing filtering
|
||||||
|
|
||||||
2. **Weekly and Monthly Summaries**
|
2. **Weekly and Monthly Summaries**
|
||||||
- Create functionality to generate weekly and monthly summaries, including filtering and sorting options.
|
- Create functionality to generate weekly and monthly summaries, including filtering and sorting options.
|
||||||
- Create a dashboard or log of "next expenses" that lists the next recurring expenses that you expect to receive
|
~~- Create a dashboard or log of "next expenses" that lists the next recurring expenses that you expect to receive~~
|
||||||
|
|
||||||
3. **Reports for Creditors and Debtors**
|
3. **Reports for Creditors and Debtors**
|
||||||
- Develop reports outlining debts or credits for each creditor and debtor to provide users with a comprehensive overview.
|
~~- Develop reports outlining debts or credits for each creditor and debtor to provide users with a comprehensive overview.~~
|
||||||
- CRUD operations for creditors and debtors
|
~~- CRUD operations for creditors and debtors~~
|
||||||
|
|
||||||
4. **Create a way to set the currency of each expense**
|
4. **Create a way to set the currency of each expense**
|
||||||
- It should be possible in the form of an expense
|
- It should be possible in the form of an expense
|
||||||
|
@ -45,12 +51,12 @@ Munera is a companion for managing expenses efficiently and effortlessly, whethe
|
||||||
- If possible, the calculations should take into account the different currencies
|
- If possible, the calculations should take into account the different currencies
|
||||||
|
|
||||||
5. **Events**
|
5. **Events**
|
||||||
- Options to create events in which to put expenses (vacations, congress, etc)
|
~~- 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
|
~~- Each event has a number of people connected to it, expenses can be added to these people~~
|
||||||
- A reports tells which people need to give/take money to which people in order to be even
|
- A reports tells which people need to give/take money to which people in order to be even
|
||||||
|
|
||||||
## Known Issues
|
## Known Issues
|
||||||
|
|
||||||
- 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.
|
- 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.
|
||||||
- Creditors and debtors calculations can be improved
|
- Graphs still need a lot of improvements
|
||||||
- Creditors and debtors need more validation when set in the form (ex. an expense cant have the same creditor and debtor)
|
- PeriodUnit and Interval need to be implemented
|
Loading…
Reference in a new issue