PS-Nutr.io

University

• ISEL - Instituto Superior de Engenharia de Lisboa, Lisbon, Portugal

Group Constitution

• Pedro Pires, Number 42206
  • University email: [email protected]
  • GitHub page: https://github.com/Pedrokase
• Miguel Luís, Number 43504
  • University email: [email protected]
  • GitHub page: https://github.com/mig07
• David Albuquerque, Number 43566
  • University email: [email protected]
  • GitHub page: https://github.com/davidalb97

Software required

The following software is required on your machine in order for the project to be executed:

• Git - Required in order to obtain project's code via Github.
• PostgreSQL 11 - Dependency used by project's HTTP-based server.
  • Optionally, psql command via command line, which allows an easier database setup.
• PostGIS - A PostgreSQL 11 add-on that enables Geolocation-based queries, which can be found here.
• Java JDK 11.06 (LTS) - Required in order to execute generated project's jar.
• Gradle - Required in order to build and generate project's server jar.
• Android Studio - Required in order to execute the android application.

Setup

Once previously required software is installed, all steps must be followed in given order to allow project's build and execution for both the project's HTTP-based server** and the android application:

1. Retrieve project's code using Git

   Retrieve project's code, either using a browser and accessing the project's Github Repository; or via the command line, using the following git command:

   git clone https://github.com/davidalb97/PS-Nutr.io.git

2. Setup database dependency

   After PostgreSQL 11 has been downloaded, a database that will contain all of the system's information needs to be created. Make sure to remember the created database name, database creator name and password, as they will be needed.

   Once the database has been created, declare the following environment variables on your system:

   PS_POSTGRES_DB={created database name}
   PS_POSTGRES_USER={database creator name}
   PS_POSTGRES_PASSWORD={database creator password}
   PS_SERVER_SECRET={server secret password}
   PS_INSULIN_PROFILES_SECRET={secret password for insulin profiles' encryption}
   

   Without these variables, the project's HTTP-based server will be unable to connect to the database and thus fail.

   Afterwards, enable PostGIS on the newly created database using the following psql command:

   CREATE EXTENSION postgis;
   

   Finally, all provided database setup scripts must be executed. To do so, first navigate to the \PS-Nutr.io\database\v2 path and either:

   • execute the shell script runScripts.sh (this requires the psql command and a way to execute shell scripts);
   • run all .sql scripts in the numeric order they are given (e.g. 1_Nutrio_Create_Model.sql, then 2_insertCuisines.sql, and so on) in the newly created database.

3. Build, generate and run http-based server executable

   To run the HTTP-based server, an executable PS - httpserver-0.0.1-SNAPSHOT.jar must first be created using gradle.

   To do so, navigate to the \PS-Nutr.io\httpserver path and execute the following gradle command:

   gradle bootjar

   Afterwards, find the generated .jar in the \PS-Nutr.io\httpserver\build\libs folder and execute it to run the HTTP-based server with the following java command:

   java -jar "PS - httpserver-0.0.1-SNAPSHOT.jar"

   The HTTP-based server will now be running on port 8080 and can be accessed via a valid endpoint, such as GET http://localhost:8080/ingredients.

   For more information about valid endpoints, please check the annexed project's report.

4. Android

   To run the android application, an emulator with the proper API level is needed. Although the application was developed in Android 10 (API level 29), any version below it, down to Android 7 (API level 24) can be used when creating a virtual device (via Android Studio Manager).

   Afterwards, select created virtual device and press the start button on Android Studio's top bar to launch the emulator, build the project, install all the required dependencies and execute the Android application.