Merge branch '68-documentation' into 'main'

Resolve "Documentation"

Closes #68

See merge request thschleicher/interaktive-systeme!59
This commit is contained in:
jastornig 2024-01-26 23:22:54 +00:00
commit 8f1753df3f
2 changed files with 12 additions and 5 deletions

View file

@ -24,12 +24,12 @@ Our design philosophy was rooted in simplicity and functionality. We aimed to cr
- **Component Development**: Built reusable components for uniformity and efficiency.
- **State Management and Hooks**: Implemented custom hooks for state management, ensuring smooth data flow and component reusability.
- [ ] **Stage 4: Implementation-Phase 2**
- [x] **Stage 4: Implementation-Phase 2**
- **Refining Components**: Enhancing component functionality and aesthetics.
- **Optimization and Debugging**: Identifying and fixing bugs, optimizing code for better performance.
- **Expanding Features**: Implementing additional pages and components to enrich the application.
- [ ] **Stage 5: Final Implementation-Phase**
- [x] **Stage 5: Final Implementation-Phase**
- **UI Touch-Ups**: Final tweaks to the user interface, ensuring a polished look and feel.
- **Finalization**: Wrapping up the project, finalizing drafts, and completing outstanding tasks.

View file

@ -25,9 +25,16 @@ A more convenient way to run Finanzfuchs is to download the prebuilt apk which c
## Usage
- **Adding Expenses**: Press the plus button to add expenses.
- **Removing Expenses**: Go to the budget tab and press the red button in the middle to reset expenses.
- **Login Screen**: Go to the login screen by pressing the profile picture in the top left of the home screen.
- **Adding Expenses(/Savings)**: Press the plus button to add expenses.
- **Removing Expenses(/Savings)**: Go to the certain expense and press it. You will then be directed to the edit expense tab, where you can change the expense as you wish.
- **Adding Categories**: Go to the budget tab and press the plus button to add a new category with custom color.
- **Removing Categories**: Go to a certain category by pressing on the budget tab and choosing one. At the top is a big button with a pencil on it, which when you press it takes you to the edit category tab, where you can customize the category or remove it completely with all expenses it contains.
- **Searching for Expenses, Savings and Categories**: At the Home Screen, the Budget tab or in a certain category you can search for certain expenses, categories or savings by writing its name in the Search bar.
- **Home Screen**: Go to the login screen by pressing the profile picture in the top left of the home screen. Furthermore, at the bottom there are the last expenses, which were added.
- **Calendar**: The calendar has little colored dots under certain days indicating, that at that day an expense has been added. By pressing at a day the list of expenses below it will be sorted out and only showing the expenses which were added at that day.
- **List of Expenses**: The list shows the most recently added expenses which can be searched through and filtered by using the calendar.
- **Profile**: By pressing at the profile picture on the home screen you get to the My Profile tab where you can activate the dark mode, reset the database and sign out of the app.
- **Stats**: Here is a Graph showing an Overview of your Budget and the sums of all expenses and savings.
## Team