diff options
Diffstat (limited to 'support/doc/server')
-rw-r--r-- | support/doc/server/code.md | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/support/doc/server/code.md b/support/doc/server/code.md index c15885c8c..76d11c963 100644 --- a/support/doc/server/code.md +++ b/support/doc/server/code.md | |||
@@ -1,11 +1,11 @@ | |||
1 | # Server code documentation | 1 | # Server code documentation |
2 | 2 | ||
3 | The server is a web server developed with [NodeJS](https://nodejs.org)/[Express](http://expressjs.com). | 3 | The server is a web server developed with [TypeScript](https://www.typescriptlang.org/)/[Express](http://expressjs.com). |
4 | 4 | ||
5 | 5 | ||
6 | ## Technologies | 6 | ## Technologies |
7 | 7 | ||
8 | * [NodeJS](https://nodejs.org) -> Language | 8 | * [TypeScript](https://www.typescriptlang.org/) -> Language |
9 | * [PostgreSQL](https://www.postgresql.org/) -> 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 | * [Sequelize](http://docs.sequelizejs.com/en/v3/) -> SQL ORM | 11 | * [Sequelize](http://docs.sequelizejs.com/en/v3/) -> SQL ORM |
@@ -15,11 +15,11 @@ The server is a web server developed with [NodeJS](https://nodejs.org)/[Express] | |||
15 | 15 | ||
16 | ## Files | 16 | ## Files |
17 | 17 | ||
18 | The server main file is [server.js](https://github.com/Chocobozzz/PeerTube/blob/master/server.js). | 18 | The server main file is [server.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server.ts). |
19 | The server modules description are in the [package.json](https://github.com/Chocobozzz/PeerTube/blob/master/package.json) at the project root. | 19 | The server modules description are in the [package.json](https://github.com/Chocobozzz/PeerTube/blob/master/package.json) at the project root. |
20 | All other server files are in the [server](https://github.com/Chocobozzz/PeerTube/tree/master/server) directory: | 20 | All other server files are in the [server](https://github.com/Chocobozzz/PeerTube/tree/master/server) directory: |
21 | 21 | ||
22 | server.js -> app initilization, main routes configuration (static routes...) | 22 | server.ts -> app initilization, main routes configuration (static routes...) |
23 | config -> server YAML configurations (for tests, production...) | 23 | config -> server YAML configurations (for tests, production...) |
24 | scripts -> Scripts files for npm run | 24 | scripts -> Scripts files for npm run |
25 | server | 25 | server |
@@ -42,9 +42,9 @@ Uses [JavaScript Standard Style](http://standardjs.com/). | |||
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 PostgreSQL and create the database `peertube_dev`. | 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 dist/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.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server/initializers/constants.ts)). |
48 | 48 | ||
49 | `npm run help` gives you all available commands. | 49 | `npm run help` gives you all available commands. |
50 | 50 | ||
@@ -68,5 +68,5 @@ If a user wants to watch the video, the tracker will indicate all other users th | |||
68 | 68 | ||
69 | ## Newcomers | 69 | ## Newcomers |
70 | 70 | ||
71 | The server entrypoint is [server.js](https://github.com/Chocobozzz/PeerTube/blob/master/server.js). You can begin to look at this file. | 71 | The server entrypoint is [server.ts](https://github.com/Chocobozzz/PeerTube/blob/master/server.ts). You can begin to look at this file. |
72 | 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. | 72 | 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. |