X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=README.md;h=34cddc56f454eb411aea4c27285861c19f521126;hb=9e9b8a0f6eae90c4ef5d224273a30a8dba2223df;hp=1e1b1db560d2144072f83a0be9b45549054a0550;hpb=dcc700d2c86f1e1c9d740860acc1277830ce955f;p=github%2FChocobozzz%2FPeerTube.git diff --git a/README.md b/README.md index 1e1b1db56..34cddc56f 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,8 @@ [![Build Status](https://travis-ci.org/Chocobozzz/PeerTube.svg?branch=master)](https://travis-ci.org/Chocobozzz/PeerTube) [![Dependencies Status](https://david-dm.org/Chocobozzz/PeerTube.svg)](https://david-dm.org/Chocobozzz/PeerTube) +[![devDependency Status](https://david-dm.org/Chocobozzz/PeerTube/dev-status.svg)](https://david-dm.org/Chocobozzz/PeerTube#info=devDependencies) +[![Code climate](https://codeclimate.com/github/Chocobozzz/PeerTube/badges/gpa.svg)](https://codeclimate.com/github/Chocobozzz/PeerTube) Prototype of a decentralized video streaming platform using P2P (bittorrent) directly in the web browser with [webtorrent](https://github.com/feross/webtorrent). @@ -20,12 +22,13 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t - [ ] Frontend - [X] Simple frontend (All elements are generated by jQuery) - - [ ] AngularJS frontend -- [ ] Join a network + - [ ] Angular 2 frontend +- [X] Join a network - [X] Generate a RSA key - [X] Ask for the friend list of other pods and make friend with them - - [ ] Get the list of the videos owned by a pod when making friend with it - - [ ] Post the list of its own videos when making friend with another pod + - [X] Get the list of the videos owned by a pod when making friend with it + - [X] Post the list of its own videos when making friend with another pod +- [X] Quit a network - [X] Upload a video - [X] Seed the video - [X] Send the meta data to all other friends @@ -51,11 +54,18 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t ### Dependencies - * NodeJS == 0.12 - * Grunt-cli (npm install -g grunt-cli) + * **NodeJS >= 4.2** * OpenSSL (cli) * MongoDB - * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 (for electron) + * xvfb-run libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin (for electron) + +#### Debian + +Install NodeJS 4.2: [https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions) + + # apt-get install mongodb openssl xvfb curl sudo git build-essential libgtk2.0-0 libgconf-2-4 libnss3 libasound2 libxtst6 libxss1 libnotify-bin + # npm install -g electron-prebuilt + ### Test It! @@ -63,14 +73,15 @@ Thanks to [webtorrent](https://github.com/feross/webtorrent), we can make P2P (t $ cd PeerTube # npm install -g electron-prebuilt $ npm install + $ npm run build $ npm start ### Test with 3 fresh nodes - $ scripts/clean_test.sh - $ scripts/run_servers.sh + $ bin/clean_test.sh + $ bin/run_servers.sh -Then you will can access to the three nodes at http://localhost:900{1,2,3}. If you call "make friends" on http://localhost:9002, the pod 2 and 3 will become friends. Then if you call "make friends" on http://localhost:9001 it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :) +Then you will can access to the three nodes at `http://localhost:900{1,2,3}`. If you call "make friends" on `http://localhost:9002`, the pod 2 and 3 will become friends. Then if you call "make friends" on `http://localhost:9001` it will become friend with the pod 2 and 3 (check the configuration files). Then the pod will communicate with each others. If you add a video on the pod 3 you'll can see it on the pod 1 and 2 :) ### Dockerfile