JW Showcase is an open-source video website builder. It enables anyone to create a beautiful, mobile-responsive HTML5 video site in 15 minutes with no coding and minimal configuration.
Clone or download
Latest commit 11a5011 Nov 7, 2018

README.md

JW Showcase

JW Showcase is an open-source, dynamically generated video website built around JW Player and JW Platform services. It enables you to easily publish your JW Player-hosted video content with no coding and minimal configuration.

You can use JW Showcase with other content delivery platforms (or your own CDN), but you will need to modify the source code.

To see an example of JW Showcase in action, see tv.jwplayer.com.

Supported Features

  • Works with any JW Player edition, from Free to Enterprise (note that usage will count against your monthly JW streaming limits). Only cloud-hosted JW Players are supported.
  • It looks great on any device. The Showcase responsive UI automatically optimizes itself for desktop, tablet, and mobile screens.
  • Populates your site's media content using JSON feeds. If you are using JW Platform, this happens auto-magically based on playlists that you specify. Using feeds from other sources will require you to hack the source code.
  • Video titles, descriptions and hero images are populated from JW Platform JSON feed metadata.
  • Playback of HLS video content from the JW Platform CDN. You can add external URLs (for example, URLS from your own server or CDN) to your playlists in the Content section of your JW Player account dashboard, but they must be HLS streams (.m3u8 files).
  • Support for live video streams (must be registered as external .m3u8 URLs in your JW Dashboard).
  • Customize the user interface with your own branding. The default app is configured for JW Player branding and content but you can easily change this to use your own assets by modifying the config.json file. Advanced customization is possible (for example, editing the CSS files), but you will need to modify the source code and build from source.
  • Site-wide video search and related video recommendations powered by JW Recommendations.
  • Basic playback analytics is reported to your JW Dashboard.
  • Ad integrations (VAST, VPAID, GoogleIMA, etc.). These features require a JW Player Ads Edition license. For more information, see the JW Player pricing page.
  • A "Watchlist" feature for users to save videos for watching later. A separate list for "Continue Watching" is also kept so users can resume watching videos where they left off. The lists are per-browser at this time (i.e., lists do not sync across user's browsers or devices). The Continue Watching list can be disabled in your Showcase config.json file.
  • A grid view for a particular playlist of videos, with the ability to deep-link to the playlist through a static URL.
  • Social sharing options for Facebook, Twitter, and email.
  • Option to build your Showcase as a Progressive Web App when building from the source code. For instructions, see Building a Progressive Web App with Showcase in the Wiki.

Unsupported Features

  • Security-related features (encrypted HLS, DRM, signed URLs)
  • Self-hosted JW Players

Instructions for Using JW Showcase

All the documentation for Showcase is in our Github Wiki.

Topics for general users:

Topics for advanced users:

Basic Setup

  1. Download the latest pre-compiled stable release.
  2. Extract the release archive to your web server.
  3. By default, JW Showcase assumes the site is in your top-level web document root (/). If you want to use a subdirectory (for example, /videos/), edit the index.html file and replace the slash in <base href="/"> with your directory (for example, <base href="/videos/">).
  4. Create a player in the JW Player Dashboard and get its player key.
    • The player key is the eight-character identifier of the player, not your JW Player license key.
    • To get the player key, in the JW Dashboard go to Publish > Tools. In the Cloud Hosted Player Libraries section at the top of the page, select the player you want to use from the Player Title drop down. Then, in the Cloud Player Library URL field, copy the eight-character value that appears just before .js. This value is the Player key.
    • For example, if your Cloud Player Library URL is https://content.jwplatform.com/libraries/BHYYA1V3.js, your player key is BHYYA1V3.
  5. Create one or more video playlist(s) in the JW Player Dashboard and record their eight-character playlist IDs.
  6. Configure your site by editing the config.json file in the directory where you extracted the JW Showcase release files.
    • Use the player key from the previous step in the player field.
    • Use playlist IDs for the playlistId keys in the content array.
  7. Visit your site.

Support and Bug Reporting

To report bugs and feature requests, or request help using JW Showcase, use this repository's Issues page.

v3.9.3