Skip to content

Getting Started

Andrew Richards edited this page Jan 22, 2016 · 8 revisions

Requirements

Installation

  • Verify that all of the Application Requirements have been met
  • Download / clone this repo to a local directory on your system

Configuration

Before running the application the following configuration steps must be completed:

  • In the root folder create a temp directory; this will enable file uploads
  • Edit the keys.py file in the following way:
    • Application Settings
      • Set sk = [your medvid.io application secret key value]
      • Set pk = [your medvid.io application public key value]
      • Set app_id = [your medvid.io application id]
      • Set account_id = [your medvid.io account id]
      • Set apollo_root = [medvid.io root path to the Apollo API endpoint] Learn More
      • Set mercury_root = [medvid.io root path to the Mercury API endpoint] Learn More
      • Set render_API = True to view Sample API Data including Sample cURL commands for all API interactions; render_API = False to obscure this data.
    • Video Settings
      • Set jw_key = [JW Player Enterprise key] (optional)
      • Set jw_path = [path to JW Player Enterprise files] (optional)
      • Set fp_use = True to play videos back using Flowplayer (free); fp_use = False to hide Flowplayer.

Usage

  • Via command line navigate to local directory on machine where the medvid.io Web App Demo is installed
  • Run python bin/app.py; local web server should start
  • Open a web browser and navigate to http://localhost:8080 to use the application

Notes on Sample API Data

To assist in development the medvid.io Web App Demo generates a collection of data to show you exactly what the backend code is doing; this includes but is not limited to Request Headers, Request Body, Request Method, Request API URL, and Sample cURL commands. This data can be used in any way necessary to assist in development.

Sample cURL Commands

The Sample cURL output is formatted in such a way as to work on Linux / Mac OS systems default cURL functionality. In some scenarios (Windows, etc) the formatting of these cURL commands will need to be customized before they will successfully function. You may need to adjust these commands (especially ', ", and " values) based on your development environment.