/GT-WebApp-Prototype

Primary LanguagePython

GT-WebApp-Prototype

This repo contains the code and the files for running the query sharing web application. The repository has two branches: master and dlab_server_v. dlab_server_v is the branch containing the version of the website that is deployed to our server: http://51.158.119.80/. The code is available under the path /var/www/dashApp in the server. master, on the other hand, is the branch containing the code used for generating the local applications (executable files). The local apps can be downloaded from here.

For installing the necessary python libraries you can just run pip install -r requirements.txt.

File descriptions

main.py - the python code running the web app.

assets/ - this folder contains header.css which defines the design of the web application. In addition, it contains the website's favicon and a couple of image files used in the web app.

sample.json - this is a sample json file used for testing the functionality of the website.

How to generate the local apps?

  1. Add os.chdir(sys._MEIPASS) to the main.py right after library imports.
  2. Run pip install pyinstaller.
  3. Run pyinstaller --onefile main.py.
  4. A file named main.spec will be generated. Edit the file by adding the following lines:

datas=[('assets/header.css', 'assets'), ('assets/submission_successful.png', 'assets'), ('assets/smth_went_wrong.png', 'assets'), ('assets/tooltip.png', 'assets'), ('assets/favicon.ico','assets'), ('PATH_TO_YOUR_DASH_CORE_COMPONENTS_PACKAGE','dash_core_components'), ('PATH_TO_YOUR_DASH_HTML_COMPONENTS_PACKAGE','dash_html_components'), ('PATH_TO_YOUR_DASH_RENDERER_PACKAGE','dash_renderer'), ('PATH_TO_YOUR_DASH_BOOTSTRAP_COMPONENTS_PACKAGE','dash_bootstrap_components')], hiddenimports=['_cffi_backend']

  1. Run pyinstaller main.spec.
  2. Access the standalone executable file in the folder dist/.

Backend

There is a small backend to the website, written in flask, which basically consists of a single POST request endpoint. Through the endpoint the submitted json files from the frontend are received and saved to the server. Each submitted file is given a unique 32-character hexadecimal string id. The backend code can be accessed via the path /var/www/webAppGT/webAppGT/_init_.py in the server.

The backend is deployed to our linux server using the web server Apache 2 and WSGI.