X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=c908d7bcb69213fab679db43aee5bce0969997d8;hb=e7dbeae8d915cdf4470ceb51c2724b04148b30b5;hp=7693fd300c20053a99319dd3c1f8687b9835ab9e;hpb=45ef55fccd120184ed5d02aaa1254a2b26162fac;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 7693fd300..c908d7bcb 100644 --- a/README.md +++ b/README.md @@ -58,8 +58,8 @@ Decentralized video streaming platform using P2P (BitTorrent) directly in the we Want to see in action? - * You can directly test in your browser with this [demo server](http://peertube.cpy.re). Don't forget to use the latest version of Firefox/Chromium/(Opera?) and check your firewall configuration (for WebRTC) - * You can find [a video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like + * [Demo server](http://peertube.cpy.re) + * [Video](https://vimeo.com/164881662 "Yes Vimeo, please don't judge me") to see how the "decentralization feature" looks like * Experimental demo servers that share videos (they are in the same network): [peertube2](http://peertube2.cpy.re), [peertube3](http://peertube3.cpy.re). Since I do experiments with them, sometimes they might not work correctly. ## Why @@ -178,14 +178,25 @@ You can check the application (CORS headers, tracker websocket...) by running: The following commands will upgrade the source (according to your current branch), upgrade node modules and rebuild client application: # systemctl stop peertube - $ npm run upgrade + $ npm run upgrade-peertube # systemctl start peertube ### Development -In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds and the client files are automatically compiled when we modify them: +In this mode, the server will run requests between pods more quickly, the videos duration are limited to a few seconds. - $ npm run dev +To develop on the server side (server files are automatically compiled when we modify them and the server restarts automatically too): + + $ npm run dev:server + +The server (with the client) will listen on `localhost:9000`. + + +To develop on the client side (client files are automatically compiled when we modify them): + + $ npm run dev:client + +The API will listen on `localhost:9000` and the frontend on `localhost:3000` (with hot module replacement, you don't need to refresh the web browser). **Username**: *root*
**Password**: *test* @@ -240,19 +251,19 @@ Here are some simple schemes:

-Decentralized +Decentralized -Watch a video +Watch a video -Watch a P2P video +Watch a P2P video -Join a network +Join a network -Many networks +Many networks

### Frontend -There already is a frontend (Angular 2) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...). +There already is a frontend (Angular) but the backend is a REST API so anybody can build a frontend (Web application, desktop application...). The backend uses BitTorrent protocol, so users could use their favorite BitTorrent client to download/play the video with its torrent URI.