diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index c4921a6..971359c 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,5 +1,7 @@ # Design Documentation for "Finanzfuchs" +# Group G + ## Introduction This document outlines the design process of the Finanzfuchs application, a comprehensive tool for personal finance management developed using React Native. The design process was centered around creating a user-friendly, efficient, and aesthetically pleasing application for managing expenses, budgets, and savings. diff --git a/README.md b/README.md index 2bebea7..53037e9 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@ # README for "Finanzfuchs" +# Group G + ## Project Title Finanzfuchs ## Installation and Setup To install and run Finanzfuchs locally: -Required: npm (node packet manager), node (recommended latest stable) +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}) +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. Use a emulator or download the `expo go` app on your phone and scan the qr code to run the app. (This may require an expo account.) +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) ** ## Usage