Skip to content

Latest commit

 

History

History
29 lines (16 loc) · 1.22 KB

README.md

File metadata and controls

29 lines (16 loc) · 1.22 KB

How to use Route Finder

Requirements: Web Browser, Python

To use Route Finder on the production server, visit our website.

To run Route Finder on a local machine, make sure Python is installed. Once installed, run the following command in the command line in order to install the required dependencies (Flask, etc.):

pip install -r requirements.txt

To startup the server, run the following command:

python backend.py config.json

Image

If the output resembles the above, the local server deployed successfully. The port on which the server is launched will be displayed in the output given by Flask (Launching flask app on port XXXX)

To access the app on a local machine, visit "http://localhost:XXXX", substituting the port number found in the previous step.

To terminate the local server, press ^C (Control-C) in the command window.

Configuration file

The config-blank.json may be renamed into config.json and filled out. The config requires the following parameters:

  • port: The port to host the web server on
  • secret_key: Used by Flask for session security. This can be set to any nonempty String
  • gapi_key: A Google Maps API key