README

This repository contains an Android app that served as a bachelor internship. The app can be administered through the Fit-Up Webapp, which is available through this repository https://github.com/githubprgrammer/Webapp-Fit-Up. The app uses the webapp "Kompass", which is available through this repository https://bitbucket.org/Alfhir/kompass.

What is this repository for?

• Aim of the bachelor internship was to create an app that provides motivational help for the user by using various scientificly designed motivation methods, with the goal to provide aid in retaining their motivations regarding sporting activities. The app shal furthermore collect psychologically interesting informations about the users behavior. The app is subject of interest regarding further development by the TU Darmstadt, Germany. For further development we suggest Android Studio.
• Version 1.0

How do I get set up?

The setup is done in two main steps:
I. Setup of the Kompass web app:

• You need a seperate project(which can be on the same firebase account) for the Kompass web app. So first create a seperate project by going to https://console.firebase.google.com/.

• Change the security rules of the the database to public

• To create the database, two shell script files are located in Kompass_Shell_Script.zip

• Replace the used URL in the two files with the URL of your database in that firebase account

• Run the shell scripts. We recommend using Git Bash.

• Enable the Email/Password Sign-In Method (Go to the Authentication section on the left side bar, select the Sign-in Method tab and enable Email/Password )

• Finally change the DAL_Utilities class in the DataAccessLayer package and set KompassURL to the URL of the database of Kompass.

• Download the project from https://bitbucket.org/Alfhir/kompass

• Change the connection string which is located in src/app/app.module.ts as "export const firebaseConfig" to the connection of your webhost in firebase. (You will find your connection string by going to your firebase account -> Overview -> Click on "Add Firebase to your web app" and copy the data from the config variable)

• Setup the project as described in the readme of https://bitbucket.org/Alfhir/kompass

• Host the web site (in the www folder) in firebase (you have to install node.js, if you haven't done the last step)

  • install firebase tools: npm intall -g firebase-tools
  • insert command: firebase login and login in your firebase account
  • go to the directory of your web app (inside www folder) and put the whole content in a new subfolder and rename it.
  • run the command inside the www folder: firebase init
  • Enter 'y' to the question "Are you ready to proceed"
  • To the question: "What Firebase CLI features do you want ot setu for this folder?" Let just "Hosting" selected and deselect the other ones (Database and Functions)
  • When asked about the Firebase project you have to associate, select the project you created for the Kompass web app.
  • When asked what you want to use as your public directory, enter the name of the subfolder you have put the files of www folder in.
  • Asked about single page app and to rewrite all urls to index.html, answer with No
  • When asked to overwrite index.html, say No.
  • Now you have to deploy your web app in firebase with the command: firebase deploy
  • After your web site has been deployed successfully, a Hosting URL will be displayed. Copy this URL and set it in the app module gradle file (app/build.gradle) as the value of "KompassWeb_IP" of the Android project, after you have cloned it in step II. (pay attention that the URL has to have a slash at the end of the address "https://FIREBASE_ADDRESS/")

II. Setup of the native App:

• download Android Studio https://developer.android.com/studio/index.html
• run the installer and install Android Studio with the default/standard settings (Android SDK included)
• start Android Studio
• download the repository and unzip it github.com/mbprog/fitup
• on the welcome screen choose "Open an existing Android Studio Project" and choose the directory of the unziped project
• on Gradle's notice (if the initial project sync fails) "Install missing platforms and sync project"
• on Gradle's notice "Install Build Tools 25.0.1 and sync project"
• log into Firebase with your Google account https://console.firebase.google.com/
• add an project to you Firebase account (so you have two)
• switch in the left side bar to "Database"
• change the security rules to public by setting ".read" : true and ".write" : true
• copy the database URL (https://example-12345.firebaseio.com)
• set it in the app module gradle file (app/build.gradle) as the value of "SportAppDB_IP"
• should you use an Android Device to debug, make sure that the USB debugging option in the developer options is enabled
• choose an emulator to run the program on and run it

Configuration

The app has been configured for android use.

Tests

This prototype has been tested manually and with help of the JUnit framework.

Deployment instructions

• install Android Studio
• update to the newest version
• import the project via VCS -> Git -> Clone
• syncronize the project's gradle files (open "build.gradle" and click on the message "Sync now" in the top right corner)
• set your database URL, as explained above
• build the APK via Build -> Build APk or Build -> Generate Signed APK
• load the APK onto an Android Smartphone with Android Version 5.0 or newer
• install the application and run it

Contribution guidelines

• Writing code: Felix Götz, Sebastian Jestädt, Mohammad Braei, Yassine Aziani, Zamir Wayandou

• Writing tests: Felix Götz, Yassine Aziani

• Code review: Felix Götz, Sebastian Jestädt, Mohammad Braei, Yassine Aziani, Zamir Wayandou

Who do I talk to?

• Send us a mail at [email protected]