diff options
| -rw-r--r-- | .gitpod.yml | 6 | ||||
| -rw-r--r-- | contributing.md | 8 | ||||
| -rw-r--r-- | readme.md | 2 |
3 files changed, 14 insertions, 2 deletions
diff --git a/.gitpod.yml b/.gitpod.yml new file mode 100644 index 00000000..ded36866 --- /dev/null +++ b/.gitpod.yml @@ -0,0 +1,6 @@ +tasks: + - init: npm install && npm i gulp -g + command: gulp +ports: + - port: 3000 + onOpen: open-preview diff --git a/contributing.md b/contributing.md index 5759fb04..b1bcc315 100644 --- a/contributing.md +++ b/contributing.md @@ -27,7 +27,13 @@ Please follow the instructions in our issue templates. Don't use github issues t * Fork Plyr, and create a new branch in your fork, based on the **develop** branch -* To test locally, you can use the demo. First make sure you have installed the dependencies with `npm install` or `yarn`. Run `gulp` to build while you are working, and run a local server from the repository root directory. If you have Python installed, this command should work: `python -m SimpleHTTPServer 8080`. Then go to `http://localhost:8080/demo/` +* To test locally, you can use the demo site. First make sure you have installed the dependencies with `npm install` or `yarn`. Run `gulp` to build and it will run a local web server for development and watch for any changes. + +### Online one-click setup + +Alternatively can also use Gitpod, a free online Visual Studio Code-like IDE. With a single click it will automatically launch a ready-to-code workspace with all the dependencies pre-installed, gulp watching for changes and the web server running, so that you can start coding straightaway. + +[](https://gitpod.io/from-referrer/) * Develop and test your modifications. @@ -1,6 +1,6 @@ Plyr is a simple, lightweight, accessible and customizable HTML5, YouTube and Vimeo media player that supports [_modern_](#browser-support) browsers. -[Checkout the demo](https://plyr.io) - [Donate](#donate) - [Slack](https://bit.ly/plyr--chat) - [](https://badge.fury.io/js/plyr) +[Checkout the demo](https://plyr.io) - [Donate](#donate) - [Slack](https://bit.ly/plyr--chat) - [](https://badge.fury.io/js/plyr) [](https://gitpod.io/#https://github.com/sampotts/plyr) [](https://plyr.io) |