CMPE451 Group-12

Description

This is the github repository that we use for CMPE451 as Group-12. You can see more details on our Wiki page

Group Members

• Adalet Veyis Turgut
• İhsan Gökcül
• Kürşat Talha Berk Yamanoğlu
• Burakcan Kazım Yeşil
• Refika Kalyoncu (Communicator)
• Ömer Yılmaz
• Zahit Batuhan Tongarlak
• Ahmet Berat Can

Old Members

• Mehmet Gökay Yıldız
• Doğukan Türksoy

System Requirements

Android

• Minimum Android Sdk version: 21 (Devices with SDK 21 or higher can run the application)
• Compile SDK version: 31 (A computer with SDK 31 can compile the application to create '.apk' file)
• Devices need Internet connection to run the application

Backend

• minimum JDK version: 11
• Gradle

Frontend

• Minimum npm version: 8.0.0
• One of web browsers: Chrome, firefox, safari
• Devices need Internet connection to connect the frontend

---

Installation Instructions

Android

Opening the project using Android Studio:

1. After cloning or downloading the project to your machine, you need to open Android Studio
2. From Android Studio open an existing project using the menu File>Open.
3. You need to select '<downloaded_folder>/application/android/' folder from the opened popup menu to open BeABee Android Application.

Creating an .apk file:

1. Open Build>Build Bundle(s) / Apk(s)>Build Apk(s) menu.
2. After the apk is generated there is gonna be dialog on bottom right of the window, from there you can select 'locate' to find the apk file.

Running the application on Emulator:

1. Set-up an emulator device with at least SDK 21, using the instructions on this page
2. Run the application on the created emulator using the instructions on this page

Backend

To build the image we first need to build a bootable jar. Then we can create our image using Dockerfile provided, then run it with docker-compose.yml file and docker-compose.

• To build the bootable jar of our application, in the root directory of our backend project we need to run:

./gradlew bootJar

• After gradle built our project, we can create our Docker Image by running

docker build . -t beabeeapp/beabee

in the same directory as before.

• After creating our Docker Image we can run it using docker compose. In the parent directory of our application, run:

docker-compose up -d beabee-server

This will run our backend server and an PostgreSQL container at the same docker network. Even if you do not have PostgreSQL image in your system it will pull it from the DockerHub.

Frontend

Since the backend URL is hardcoded in the project files, first we need to clone the repository. Locate the index.tsx file. In that file change

axios.defaults.baseURL = "http://3.144.201.198:8085/v2";

to

axios.defaults.baseURL = "http://'backend-ip-address':'port'/v2";

To create a Docker Image of the Web Application, we need to build the project via react build script in our machine first. To achieve this we install dependencies.

• To install dependencies in the frontend project's root directory run

npm install

• To build the project in the frontend project's root directory run

npm run build

This uses the build script coming from react-scripts dependency to build a product ready build of the application.

• To create the Docker Image, again in the root directory run:

docker build . -t beabeeapp/beabee-front

• And then you can run this Docker Image you've created via docker-compose file in the parent directory of the project run.

docker-compose up -d beaabee-front

This will run frontend application, backend application and database in the same Docker network.
However since frontend application depends on the backend application, you need to create the backend application's image first.

Using docker-compose and loading up the database dump

After creating Docker Images for Backend and Frontend application. We can use docker-compose software run them together in the same network to connect them both smoothly. To use docker-compose you need:

• Docker

• docker-compose

both installed in your system.

To use compose navigate to application/ folder, which contains project directories for backend, frontend and android alongside a docker-compose.yml file. This file contains all the configuration and enviromental variables for the images we are using. It also runs them in the same network it created to connect them all. With this file we can run our newly created images.

• To run all the services:

docker-compose up -d

• To run database:

docker-compose up -d db-server

• To run the backend service alone:

docker-compose up -d beabee-server

This will also run the db-server since backend server also depends on the database service.

• And we can run the frontend service with:

docker-compose up -d beabee-front

However since frontend depends on backend server this will cause all services to be up along with the frontend server.

After running both of our services you can navigate to localhost:3000 for our frondend and localhost:8085 for backend server.

Restoring the Database Dump

After running database service via docker-compose you can restore the database dump we've created. To do this navigate to application/ directory and run:

cat backup_dump.sql | docker exec -i db-server psql -U postgres

This will load up the data to database, and then you can access the data or use it in our application.

• Note: backup_dump.sql will be supplied to the customer via mail. If you need it please contact vturgut68@gmail.com