diff options
author | Chocobozzz <florian.bigard@gmail.com> | 2017-01-12 15:20:03 +0100 |
---|---|---|
committer | Chocobozzz <florian.bigard@gmail.com> | 2017-01-12 15:20:03 +0100 |
commit | 99fe265a5fc077cb66c322e7f3d191ff7110aea0 (patch) | |
tree | c9e04ccfcc5496d2300d7c26db5833e494b4cdad /support/doc | |
parent | fcc5f77b95d330bfcb439c172b7fcc58f3162e4d (diff) | |
parent | 91cc839af88730ba55f84997c56b85ea100070a7 (diff) | |
download | PeerTube-99fe265a5fc077cb66c322e7f3d191ff7110aea0.tar.gz PeerTube-99fe265a5fc077cb66c322e7f3d191ff7110aea0.tar.zst PeerTube-99fe265a5fc077cb66c322e7f3d191ff7110aea0.zip |
Merge branch 'postgresql'
Diffstat (limited to 'support/doc')
-rw-r--r-- | support/doc/client/code.md | 2 | ||||
-rw-r--r-- | support/doc/server/code.md | 10 |
2 files changed, 6 insertions, 6 deletions
diff --git a/support/doc/client/code.md b/support/doc/client/code.md index 3c2029847..f629af32f 100644 --- a/support/doc/client/code.md +++ b/support/doc/client/code.md | |||
@@ -54,7 +54,7 @@ Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [An | |||
54 | 54 | ||
55 | * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) | 55 | * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) |
56 | * Run `npm install` at the root directory to install all the dependencies | 56 | * Run `npm install` at the root directory to install all the dependencies |
57 | * Run MongoDB | 57 | * Run PostgreSQL and create the database `peertube_dev`. |
58 | * Run `npm run dev` to compile the client and automatically run the server. Then the server will watch and compile the client files automatically. You just need to refresh the browser to see your modifications. | 58 | * Run `npm run dev` to compile the client and automatically run the server. Then the server will watch and compile the client files automatically. You just need to refresh the browser to see your modifications. |
59 | 59 | ||
60 | In a Angular 2 application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionnaly a SASS file. | 60 | In a Angular 2 application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionnaly a SASS file. |
diff --git a/support/doc/server/code.md b/support/doc/server/code.md index 652bd53df..c15885c8c 100644 --- a/support/doc/server/code.md +++ b/support/doc/server/code.md | |||
@@ -6,9 +6,9 @@ The server is a web server developed with [NodeJS](https://nodejs.org)/[Express] | |||
6 | ## Technologies | 6 | ## Technologies |
7 | 7 | ||
8 | * [NodeJS](https://nodejs.org) -> Language | 8 | * [NodeJS](https://nodejs.org) -> Language |
9 | * [MongoDB](https://www.mongodb.com/) -> Database | 9 | * [PostgreSQL](https://www.postgresql.org/) -> Database |
10 | * [Express](http://expressjs.com) -> Web server framework | 10 | * [Express](http://expressjs.com) -> Web server framework |
11 | * [Mongoose](http://mongoosejs.com/) -> MongoDB object modeling | 11 | * [Sequelize](http://docs.sequelizejs.com/en/v3/) -> SQL ORM |
12 | * [WebTorrent](https://webtorrent.io/) -> BitTorrent tracker and torrent creation | 12 | * [WebTorrent](https://webtorrent.io/) -> BitTorrent tracker and torrent creation |
13 | * [Mocha](https://mochajs.org/) -> Test framework | 13 | * [Mocha](https://mochajs.org/) -> Test framework |
14 | 14 | ||
@@ -28,7 +28,7 @@ All other server files are in the [server](https://github.com/Chocobozzz/PeerTub | |||
28 | |__ initializers -> functions used at the server startup (installer, database, constants...) | 28 | |__ initializers -> functions used at the server startup (installer, database, constants...) |
29 | |__ lib -> library function (WebTorrent, OAuth2, friends logic...) | 29 | |__ lib -> library function (WebTorrent, OAuth2, friends logic...) |
30 | |__ middlewares -> middlewares for controllers (requests validators, requests pagination...) | 30 | |__ middlewares -> middlewares for controllers (requests validators, requests pagination...) |
31 | |__ models -> Mongoose models for each MongoDB collection (videos, users, pods...) | 31 | |__ models -> Sequelize models for each SQL tables (videos, users, pods...) |
32 | |__ tests -> API tests and real world simulations (to test the decentralized feature...) | 32 | |__ tests -> API tests and real world simulations (to test the decentralized feature...) |
33 | 33 | ||
34 | 34 | ||
@@ -41,7 +41,7 @@ Uses [JavaScript Standard Style](http://standardjs.com/). | |||
41 | 41 | ||
42 | * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) | 42 | * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) |
43 | * Run `npm install` at the root directory to install all the dependencies | 43 | * Run `npm install` at the root directory to install all the dependencies |
44 | * Run MongoDB | 44 | * Run PostgreSQL and create the database `peertube_dev`. |
45 | * Run `npm run dev` to compile the client and automatically run the server. If the client files are already compiled you can simply run `NODE_ENV=test node server` | 45 | * Run `npm run dev` to compile the client and automatically run the server. If the client files are already compiled you can simply run `NODE_ENV=test node server` |
46 | 46 | ||
47 | The `NODE_ENV=test` is set to speed up communications between pods (see [constants.js](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.js)). | 47 | The `NODE_ENV=test` is set to speed up communications between pods (see [constants.js](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.js)). |
@@ -62,7 +62,7 @@ A video is seeded by the server throught the [WebSeed](http://www.bittorrent.org | |||
62 | 62 | ||
63 | ![Architecture scheme](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/upload-video.png) | 63 | ![Architecture scheme](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/upload-video.png) |
64 | 64 | ||
65 | When a user uploads a video, the rest API create the torrent file and then adds it to its Mongo database. | 65 | When a user uploads a video, the rest API create the torrent file and then adds it to its database. |
66 | 66 | ||
67 | If a user wants to watch the video, the tracker will indicate all other users that are watching the video + the HTTP url for the WebSeed. | 67 | If a user wants to watch the video, the tracker will indicate all other users that are watching the video + the HTTP url for the WebSeed. |
68 | 68 | ||