2016-07-22 11:44:46 +02:00
# Server code documentation
2017-06-11 11:02:35 +02:00
The server is a web server developed with [TypeScript ](https://www.typescriptlang.org/ )/[Express](http://expressjs.com).
2016-07-22 11:44:46 +02:00
## Technologies
2017-06-11 11:02:35 +02:00
* [TypeScript ](https://www.typescriptlang.org/ ) -> Language
2016-12-25 09:53:50 +01:00
* [PostgreSQL ](https://www.postgresql.org/ ) -> Database
2016-07-22 11:44:46 +02:00
* [Express ](http://expressjs.com ) -> Web server framework
2016-12-25 09:53:50 +01:00
* [Sequelize ](http://docs.sequelizejs.com/en/v3/ ) -> SQL ORM
2016-10-07 11:01:28 +02:00
* [WebTorrent ](https://webtorrent.io/ ) -> BitTorrent tracker and torrent creation
2016-07-22 11:44:46 +02:00
* [Mocha ](https://mochajs.org/ ) -> Test framework
## Files
2017-06-11 11:02:35 +02:00
The server main file is [server.ts ](https://github.com/Chocobozzz/PeerTube/blob/master/server.ts ).
2016-07-22 11:44:46 +02:00
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:
2017-06-11 11:02:35 +02:00
server.ts -> app initilization, main routes configuration (static routes...)
2016-07-22 11:44:46 +02:00
config -> server YAML configurations (for tests, production...)
scripts -> Scripts files for npm run
server
|__ controllers -> API routes/controllers files
|__ helpers -> functions used by different part of the project (logger, utils...)
|__ 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...)
2016-12-25 09:53:50 +01:00
|__ models -> Sequelize models for each SQL tables (videos, users, pods...)
2016-07-22 11:44:46 +02:00
|__ tests -> API tests and real world simulations (to test the decentralized feature...)
## Conventions
Uses [JavaScript Standard Style ](http://standardjs.com/ ).
## Developing
* Install [the dependencies ](https://github.com/Chocobozzz/PeerTube#dependencies )
2017-06-14 21:37:49 +02:00
* Run `yarn install` at the root directory to install all the dependencies
2016-12-25 09:53:50 +01:00
* Run PostgreSQL and create the database `peertube_dev` .
2017-06-14 21:37:49 +02:00
* Run `npm run dev:server` to run the server, watch server files modifications and restart it automatically. The server (API + client) listen on `localhost:9000` .
2016-07-22 11:44:46 +02:00
2017-06-11 11:02:35 +02:00
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 )).
2016-07-22 11:44:46 +02:00
2016-07-27 15:34:50 +02:00
`npm run help` gives you all available commands.
2016-07-22 11:44:46 +02:00
2016-07-22 11:53:55 +02:00
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` .
2016-07-22 11:44:46 +02:00
## Architecture
The server is composed by:
2016-10-07 11:01:28 +02:00
* a REST API (throught Express framework)
2016-07-22 11:44:46 +02:00
* a WebTorrent Tracker
2016-10-07 11:01:28 +02:00
A video is seeded by the server throught the [WebSeed ](http://www.bittorrent.org/beps/bep_0019.html ) protocol (HTTP).
2016-07-22 11:44:46 +02:00
![Architecture scheme ](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/upload-video.png )
2016-12-25 09:53:50 +01:00
When a user uploads a video, the rest API create the torrent file and then adds it to its database.
2016-07-22 11:44:46 +02:00
2016-10-07 11:01:28 +02:00
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.
2016-07-22 11:44:46 +02:00
## Newcomers
2017-06-11 11:02:35 +02:00
The server entrypoint is [server.ts ](https://github.com/Chocobozzz/PeerTube/blob/master/server.ts ). You can begin to look at this file.
2016-07-22 11:44:46 +02:00
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.