210029073 / cs3ip_lh3_myeyehealth

An eye health management mobile application designed for users to manage their eye heatlh
0 stars 0 forks source link

MyEyeHealth - Eye Health Management Application

Android CI

About

For the purpose of CS3IP (Individual Project), my project is to create an eye health management mobile application designed for users to manage their eye heatlh.

Technology

Features

Setup (For Windows)

It is important to note that these instructions have been performed on a device running Windows 11, hence the user-interface may be different.

Setup IDE

  1. You will need to first install Android Studio. Download the latest version here
  2. If you are using Windows click on the installer. You will then see a User Account Control (UAC) prompt click yes to continue once completed the action.
  3. You will then see the installer with the welcome Screen like this: image

3.1. Click Next, and leave the options to default, and Click Next.

3.2. Leave the installation path set to default, and Click Next.

3.3. For Choose a Start menu, leave the options to default, and Click Install. The installer should now install Android Studio, this should take several minutes, depending on how fast is your computer.

  1. Then Click Next, Uncheck Start Android Studion, and Click Finish once installation has been completed.

  2. Create a new folder for storing the repository and Clone the repository using the git command git clone git@github.com:210029073/cs3ip_lh3_myeyehealth.git.

  3. Start Android Studio. When starting Android Studio you will see this message. image

  4. Click Don't Send.

  5. You should now see a prompt that looks similar to this: image

  6. Click on Open and Find the repository you have just cloned. image

  7. Click OK once you have founded the repository. You should now see the project being prepared by Android Studio, and fetching dependencies required from the build.gradle file. image

  8. Once this has been completed you should now see the project has been built successfully, from the ✅ icon when viewing the build icon. image

Debugging, Running Application using Android Studio.

There are two approaches for running an Android Application using Android Studio.

  1. Using a Physical Device using either USB Debugging or Wireless Debugging.
  2. Creating an Android Virtual Device (AVD) to run the application on an emulated device.

Physical Device

Setup Physical Mobile Application for USB Debugging

In order to debug, or run the mobile application directly from your mobile device you will need to enable USB Debugging, which involves enabling Developer Options. It is important to note that each Android Smartphone's UI smartphone differs for each vendor. In this example, a Samsung S20 was used to enable USB Debugging.

  1. Go to Settings.

  1. Go to About Phone.

  1. Next select Software Information.

  1. In Software Information, Tap the Build number 7 times until you see a prompt that asks you to enter your password if you have a password set your mobile device, or a message that says you are now a developer.

  1. Find Developer Options.

  1. In Developer Options Tap to turn on USB debugging, and click OK to enable USB debugging.

  1. Connect your Mobile Device to your Computer then open Android Studio, and view the Device Manager Panel. You should now see your device connected.

Setup Physical Mobile Application for Wireless Debugging

Make sure that your Smartphone is Running Android 13 or later. As this feature only works on Android 13 or later.

  1. Repeat the same steps of Setup Physical Mobile Application for USB Debugging, however select Wireless Debugging instead of USB Debugging.

Android Virtual Device

  1. On Android Studio select the Device Manager panel. You should see no devices, this is intended as you have not created a virtual device yet. image

  2. Then click the + icon:

image

  1. You should then see menu that asks you to Choose a device definition, Select the Pixel 7.

image

  1. Click Next. The menu should now ask you to Select a System Image.

image

  1. Select the System Image that has the Release Name named Tiramisu. You will notice that the option is greyed out, click on the image that is next to the Release Name. You should now see it download the System Image. image

  2. Click Finish once completed.

  3. Click Next. You should now see the menu asking you to Verify Configuration, leave the options to default, and Click Next.

  4. You should now see the Virtual Device you have just added. image

  5. Click on the image icon in order to run your application in the Virtual Device. If it runs successfully, then you have successfully completed the setup of Android Studion. However, if you recieve an error stating you have'nt installed Intel HAXM, then follow steps 11 to 12.

  6. Follow the instructions provided by Wenchao Wang for Installing Intel HAXM on Windows.

  7. Restart Android Studio.

  8. Once Android Studio has successfully restarted then follow Step 10.

Author

Ibrahim Ahmad | Email: 210029073@aston.ac.uk

Supervisor

Dr. Lilit Hakobyan | Email: l.hakobyan2@aston.ac.uk