Simple GUI to view PMP docs.
PHP
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
css Moving to Pure CSS foundation. Jul 4, 2015
.gitignore Ignore the krumo directory entirely. Jan 19, 2015
README.md Better hints around using `php -S` Feb 6, 2015
add.php Moving to Pure CSS foundation. Jul 4, 2015
credentials.sample.php Initial commit Jan 15, 2015
envoy.class.inc
favicon2.ico Initial commit Jan 15, 2015
index.php Better pager, esp. for FIRST button. Jul 31, 2015
view.php Link smaller image to full-sized image. Jan 17, 2015

README.md

BACKGROUND

  • This is a simple read-only tool to examine content in the Public Media Platform (PMP).
  • You can toggle between production and sandbox, filter your queries, or jump to a particular PMP doc (provided you know the guid).
  • DO NOT USE on a publicly available site (as it exposes permissioned content). In fact, I'd only recommend using it on a local server. It is some quick and dirty PHP, let me tell you.
  • More about the PMP: http://publicmediaplatform.org/
  • More about getting PMP credentials: https://support.pmp.io/docs#getting-started-user-registration

FAQ

Q: Why is this thing in PHP?

A: http://www.commitstrip.com/en/2015/01/12/the-right-tool-for-the-right-job/

Q: Why should I use this particular PMP tool?

A: There are lots of great tools out there. I built envoy because it was something I could easily run locally and tweak. More important, it is geared toward developers. Thus, the primary emphasis is on pouring out complicated PMP docs into an easily viewable and traversable format (via the invaluable krumo). Prettiness, alas, is sacrificed.

INSTALLATION

  • This assumes you already have a PHP + some sort of server (try php -S localhost:8888) on your local box.
  • Download the code
git clone this repo
  • Get the PHP SDK and krumo (be sure to use this specific version of the SDK; newer versions could break things)
cd envoy
git clone -b v0.1.0 --depth 1 git@github.com:publicmediaplatform/phpsdk.git
git clone git@github.com:oodle/krumo.git
  • Create a credentials file
cp credentials.sample.php credentials.php
  • Edit credentials.php, replacing <redacted> with your credentials
  • Edit your hosts file and server config files accordingly, so you can pull up envoy in your browser
  • Browse the PMP!