32 lines
No EOL
1.1 KiB
Markdown
32 lines
No EOL
1.1 KiB
Markdown
# README for "Finanzfuchs"
|
|
|
|
## Project Title
|
|
Finanzfuchs
|
|
|
|
## Installation and Setup
|
|
To install and run Finanzfuchs locally:
|
|
|
|
Required: npm (node packet manager), node (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, you might want to consider to use `npx expo start --tunnel`.
|
|
4. Press `s` in order to switch from development mode to go.
|
|
5. Use a emulator or download the `expo go` app on your phone and scan the qr code to run the app.
|
|
|
|
## 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.
|
|
|
|
## Team
|
|
|
|
- Aigensberger, Carolin
|
|
- Dworski, Daniel
|
|
- Schleicher, Thomas
|
|
- Stornig, Jakob
|
|
- Walcher, Raphael
|
|
|
|
## License
|
|
Finanzfuchs is released under the [MIT License](link to license). |