NapoleonDynamite/munera-vaadin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: README.md

Browse source
This commit is contained in:
filippo-ferrari 2024-05-24 00:12:12 +02:00
parent a8765f1e84
commit bc2864b0d9
1 changed files with 9 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
README.md
View file

@ -2,7 +2,7 @@
## Overview ## Overview
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. 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.
### 1. Expense Management ### 1. Expense Management
@ -12,29 +12,26 @@ Munera is an application designed to help users efficiently track their expenses
- Category - Category
- Cost - Cost
- Description - Description
- Period Interval (1, 2, 3) - Period Interval (1, 2, 3, etc)
- Period Unit (days, weeks, months) - Period Unit (days, weeks, months)
- Creditors and debtors - Creditors and debtors
-
- Create, read, update and delete categories
## Completed Features ## Completed Features
- [x] Create categories with CRUD operations
- [x] Create concept of creditors and debtors for each expense - [x] Create concept of creditors and debtors for each expense
- [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
## Next Steps ## Next Steps
1. **Frontend Structure** 1. **Filtering and Sorting**
- Decide on the frontend structure, most likely a Command Line Interface (CLI).
2. **CLI Design**
- If a CLI is implemented, consider designing tables and a calendar view for enhanced user experience.
3. **Filtering and Sorting**
- Implement filtering and sorting functionalities for all major entities to enhance data organization. - Implement filtering and sorting functionalities for all major entities to enhance data organization.
4. **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.
5. **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