README.md

Reuse Assessment Tool

Author: Matthew Yeow

Supervision: Chong Chun Yong / Lim Mei Kuan

Description: This is a project to supplement the author's PhD thesis work. This project is currently hosted on Streamlit.

Installation and Create Environment

1. Clone latest release

Alternatively:

git clone https://github.com/cyan-wings/Reuse-Tool.git
cd Reuse-Tool/

Linux/macOS

Install JDK 11 (Any JDK will do. This tutorial we will use OpenJDK.) and Python (Latest version).

sudo apt-get install openjdk-11-jdk
sudo apt-get install python3

Create virtual environment for the application.

python3 -m venv venv-reuse-tool
source venv-reuse-tool/bin/activate

Install Python package dependencies for application.

python3 -m pip install -r requirements.txt

Running the Application

python3 -m streamlit run About.py

Open Brave, Chrome or FireFox browser and input localhost:8501

Stopping the Application

1. Ctrl-C to terminate the process on terminal.
2. Deactivate environment.

deactivate

Uninstall Everything and Removing Application

1. Delete entire repository from folder.
2. Uninstall JDK 11 and Python.