usse/documentation/source/app.rst

=========
React App
=========

In order to use the scraped data a *react app* was developed. 
The main thing this app does is show a map, with icons for each house, while also showing the distance and travel time:

.. figure:: react_app_example.png


The app works using the generated out.json file from the scrape project. This file is compiled in the app. This makes the loading of the App quite slow.
Also a lot of markers has some impact on the performance of the app.

Usage
=====
Copy the generated *out.json* file that was generated in the *usse scrape* project to ``src/locations.json``, next you can run the app:

.. code-block:: bash

    npm run start

This should start a server running the app.

Docker
======
A dockerfile was created in order to serve the application on ``Wintergreen``. 
To use the dockerfile you can simply use the bash script: ``use_docker.sh`` and run it to run the docker container:

.. code-block:: bash

    ./use_docker.sh 

Several commands are supported:

.. code-block:: bash

    ./use_docker.sh remove
    ./use_docker.sh rebuild

Redeploy
--------
To recreate the app you can run:

.. code-block:: bash

    ./use_docker.sh recreate

filters
-------
The app also has filters for price and distance to various locations:

.. figure:: images/react_filter.png