Skip to content

Commit

Permalink
docs: spellcheck and fix feedback
Browse files Browse the repository at this point in the history
  • Loading branch information
ChristiaanScheermeijer committed Mar 19, 2024
1 parent 776b4f3 commit 2274637
Show file tree
Hide file tree
Showing 15 changed files with 268 additions and 161 deletions.
50 changes: 39 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
![JW OTT Webapp](docs/_images/homepage-screenshot.png)

The JW OTT Webapp 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.
The JW OTT Webapp 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.

**Examples of JW OTT Webapp in action:**

Expand Down Expand Up @@ -41,17 +42,30 @@ The JW OTT Webapp is an open-source, dynamically generated video website built a

## 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 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.
- 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 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).
- 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](docs/build-from-source.md).
- Site-wide video search and related video recommendations powered by [JW Recommendations](https://docs.jwplayer.com/platform/docs/vdh-create-a-recommendations-playlist).
- 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](docs/build-from-source.md).
- Site-wide video search and related video recommendations powered
by [JW Recommendations](https://docs.jwplayer.com/platform/docs/vdh-create-a-recommendations-playlist).
- 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](https://www.jwplayer.com/pricing/).
- A "Favorites" feature for users to save videos for watching later. A separate list for "Continue Watching" is also kept so users can resume watching videos from 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 JW OTT Webapp's `config.json` file.
- Ad integrations (VAST, VPAID, GoogleIMA, etc.). These features require a JW Player Ads Edition license. For more
information, see the [JW Player pricing page](https://www.jwplayer.com/pricing/).
- A "Favorites" feature for users to save videos for watching later. A separate list for "Continue Watching" is also
kept so users can resume watching videos from 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 JW OTT
Webapp's `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 using the device native sharing dialog.
- 24x7 live channel(s) screen with Electronic Programming Guide (EPG) view.
Expand All @@ -60,10 +74,24 @@ The JW OTT Webapp is an open-source, dynamically generated video website built a

- Self-hosted JW Players

## Getting started

The easiest way to get the OTT Web App running on your machine, use the following commands:

```shell
$ yarn
$ yarn web start
```

These commands will install all dependencies and start a dev server serving the web app. Read
the [full documentation](./platforms/web/README.md) for more information about the web app.

## Support and Bug Reporting

To report bugs and feature requests, or request help using JW OTT Webapp, use this repository's [Issues](https://github.com/jwplayer/ott-web-app/issues) page.
To report bugs and feature requests, or request help using JW OTT Webapp, use this
repository's [Issues](https://github.com/jwplayer/ott-web-app/issues) page.

## Software License

This project is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0). See [LICENSE.txt](LICENSE.txt) for more details.
This project is licensed under the [Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
See [LICENSE.txt](LICENSE.txt) for more details.
Loading

0 comments on commit 2274637

Please sign in to comment.