# README for "Finanzfuchs"

# Group G

## Project Title
Finanzfuchs

## Installation and Setup
### Run with expo go (ios and Android)
To install and run Finanzfuchs locally:

Required: `npm` (node packet manager), `node.js` (recommended latest stable)

1. Clone the main-branch of this repository to your local machine. (`git clone {adress}`)
2. Navigate to the project directory and run `npm install` to install dependencies.
3. Start the app by executing `npm start`. If this does not work for you, try using `npx expo start --tunnel`.
4. If you want to use a Physical Device see the below Steps, else skip to `5.`
    1. Make sure the Device is **on the same Network** as your PC 
    2. Download the `Expo Go`-App on iOS or Android respectively.
    3. After installing, just scan the QR Code using the App on Android or the Camera-App on iOS.
5. Alternatively you can use an Emulator using Android SDK or the iOS equivalent. After starting the server, press the prefered Button `a` for Android, `i` for iOS or `w` for Web-View **(Web-View is currently not supported) **

### Prebuilt apk (Android only)
A more convenient way to run Finanzfuchs is to download the prebuilt apk which can be found under releases in this GitLab repository. This apk file will be kept up to date. Just download and install the most recent version.

## Usage

- **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

- Aigensberger, Carolin
- Dworski, Daniel
- Schleicher, Thomas
- Stornig, Jakob
- Walcher, Raphael

## License
Finanzfuchs is released under the [MIT License].
