Better build/dev scripts

[github/Chocobozzz/PeerTube.git] / support / doc / server / code.md

diff --git a/support/doc/server/code.md b/support/doc/server/code.md
index d49d120e928f951d3aa9afe68817fcb1c5fab318..13e5923351c3eef60f23d2414bec6d5d9f21fba1 100644 (file)
--- a/support/doc/server/code.md
+++ b/support/doc/server/code.md
@@ -1,26 +1,25 @@
 # Server code documentation
 
-The server is a web server developed with [NodeJS](https://nodejs.org)/[Express](http://expressjs.com).
+The server is a web server developed with [TypeScript](https://www.typescriptlang.org/)/[Express](http://expressjs.com).
 
 
 ## Technologies
 
-  * [NodeJS](https://nodejs.org) -> Language
-  * [MongoDB](https://www.mongodb.com/) -> Database
+  * [TypeScript](https://www.typescriptlang.org/) -> Language
+  * [PostgreSQL](https://www.postgresql.org/) -> Database
   * [Express](http://expressjs.com) -> Web server framework
-  * [Mongoose](http://mongoosejs.com/) -> MongoDB object modeling
-  * [WebTorrent](https://webtorrent.io/) -> BitTorrent over WebRTC
-  * [Electron](http://electron.atom.io/) -> To make WebRTC inside NodeJS
+  * [Sequelize](http://docs.sequelizejs.com/en/v3/) -> SQL ORM
+  * [WebTorrent](https://webtorrent.io/) -> BitTorrent tracker and torrent creation
   * [Mocha](https://mochajs.org/) -> Test framework
 
 
 ## Files
 
-The server main file is [server.js](https://github.com/Chocobozzz/PeerTube/blob/master/server.js).
+The server main file is [server.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server.ts).
 The server modules description are in the [package.json](https://github.com/Chocobozzz/PeerTube/blob/master/package.json) at the project root.
 All other server files are in the [server](https://github.com/Chocobozzz/PeerTube/tree/master/server) directory:
 
-    server.js -> app initilization, main routes configuration (static routes...)
+    server.ts -> app initilization, main routes configuration (static routes...)
     config    -> server YAML configurations (for tests, production...)
     scripts   -> Scripts files for npm run
     server
@@ -29,7 +28,7 @@ All other server files are in the [server](https://github.com/Chocobozzz/PeerTub
     |__ initializers -> functions used at the server startup (installer, database, constants...)
     |__ lib          -> library function (WebTorrent, OAuth2, friends logic...)
     |__ middlewares  -> middlewares for controllers (requests validators, requests pagination...)
-    |__ models       -> Mongoose models for each MongoDB collection (videos, users, pods...)
+    |__ models       -> Sequelize models for each SQL tables (videos, users, pods...)
     |__ tests        -> API tests and real world simulations (to test the decentralized feature...)
 
 
@@ -42,33 +41,32 @@ Uses [JavaScript Standard Style](http://standardjs.com/).
 
   * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies)
   * Run `npm install` at the root directory to install all the dependencies
-  * Run MongoDB
-  * 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`
+  * Run PostgreSQL and create the database `peertube_dev`.
+  * Run `npm run dev:server` to compile the client, run the server and watch server files modifications.
 
-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#L71)).
+The `NODE_ENV=test` is set to speed up communications between pods (see [constants.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.ts)).
 
-`npm run help` give you all available commands.
+`npm run help` gives you all available commands.
 
-If you want to test the decentralization feature, you can easily run 3 pods by runnin `npm run play`. The pods password are `test1`, `test2` and `test3`.
+If you want to test the decentralization feature, you can easily run 3 pods by running `npm run play`. The pods password are `test1`, `test2` and `test3`.
 
 
 ## Architecture
 
 The server is composed by:
 
-  * a REST API
+  * a REST API (throught Express framework)
   * a WebTorrent Tracker
-  * A separate Electron process
 
-The seperate Electron process has the goal to seed videos through WebRTC because WebRTC directly in NodeJS is not usable for now.
+A video is seeded by the server throught the [WebSeed](http://www.bittorrent.org/beps/bep_0019.html) protocol (HTTP).
 
 ![Architecture scheme](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/upload-video.png)
 
-When an user upload a video, the rest API asks the Electron process to seed it (communicate with IPC) and then adds it to its Mongo database.
+When a user uploads a video, the rest API create the torrent file and then adds it to its database.
 
-If an user wants to watch the video, the tracker will indicate all other users that are watching the video + the Electron process.
+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.
 
 ## Newcomers
 
-The server entrypoint is [server.js](https://github.com/Chocobozzz/PeerTube/blob/master/server.js). You can begin to look at this file.
+The server entrypoint is [server.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server.ts). You can begin to look at this file.
 Then you can try to understand the [controllers](https://github.com/Chocobozzz/PeerTube/tree/master/server/controllers): they are the entrypoint of each API request.