A web video player built for the HTML5 world using React library.
Latest commit f30f42d Oct 29, 2018

README.md

video-react

npm version Build Status Package Quality

Video.React is a web video player built from the ground up for an HTML5 world using React library.

Installation

Install video-react and peer dependencies via NPM

npm install --save video-react react react-dom

import css in your app or add video-react styles in your page

import "~video-react/dist/video-react.css"; // import css

or

@import "~video-react/styles/scss/video-react"; // or import scss

or

<link rel="stylesheet" href="https://video-react.github.io/assets/video-react.css" />

Import the components you need, example:

import React from 'react';
import { Player } from 'video-react';

export default (props) => {
  return (
    <Player>
      <source src="https://media.w3.org/2010/05/sintel/trailer_hd.mp4" />
    </Player>
  );
};

Development

Run tests:

npm test

run from local

$ npm install
$ npm start

Releasing

Create Release Branch

To create a release branch and changelog, run the following command, optionally with a semantic release type (major, minor, patch) (if not provided, it will default to semver (it's best to let it default)):

./scripts/release <release-type>

Verify changelog in branch. Create a PR if everything looks good. Merge when tests are green.

Tagging and Publishing

Once the release branch is merged, checkout master and run:

./scripts/publish

Inspiration & Credits