aboutsummaryrefslogtreecommitdiffhomepage
path: root/support/doc
diff options
context:
space:
mode:
Diffstat (limited to 'support/doc')
-rw-r--r--support/doc/development/client/code.md (renamed from support/doc/client/code.md)11
-rw-r--r--support/doc/development/client/components-tree.png (renamed from support/doc/client/components-tree.png)bin47396 -> 47396 bytes
-rw-r--r--support/doc/development/server/code.md (renamed from support/doc/server/code.md)2
-rw-r--r--support/doc/development/server/upload-video.png (renamed from support/doc/server/upload-video.png)bin56458 -> 56458 bytes
4 files changed, 8 insertions, 5 deletions
diff --git a/support/doc/client/code.md b/support/doc/development/client/code.md
index 99298f21e..ddd277e54 100644
--- a/support/doc/client/code.md
+++ b/support/doc/development/client/code.md
@@ -32,18 +32,21 @@ Here is the description of the useful `client` files directory:
32 |__ index.html -> root HTML file for our Angular application 32 |__ index.html -> root HTML file for our Angular application
33 |__ main.ts -> Main TypeScript file that boostraps our Angular application 33 |__ main.ts -> Main TypeScript file that boostraps our Angular application
34 |__ polyfills.ts -> Polyfills imports (ES 2015...) 34 |__ polyfills.ts -> Polyfills imports (ES 2015...)
35 |__ vendor.ts -> Vendor imports (Angular, Bootstrap...)
36 35
37Details of the Angular application file structure. It tries to follow [the official Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html). 36Details of the Angular application file structure. It tries to follow [the official Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html).
38 37
39 app 38 app
39 |__ +admin -> Admin components (followers, users...)
40 |__ account -> Account components (password change...) 40 |__ account -> Account components (password change...)
41 |__ admin -> Admin components (friends, users...)
42 |__ core -> Core components/services 41 |__ core -> Core components/services
42 |__ header -> Header components (logo, search...)
43 |__ login -> Login component 43 |__ login -> Login component
44 |__ menu -> Menu component (on the left)
44 |__ shared -> Shared components/services (search component, REST services...) 45 |__ shared -> Shared components/services (search component, REST services...)
46 |__ signup -> Signup form
45 |__ videos -> Video components (list, watch, upload...) 47 |__ videos -> Video components (list, watch, upload...)
46 |__ app.component.{html,scss,ts} -> Main application component 48 |__ app.component.{html,scss,ts} -> Main application component
49 |__ app-routing.module.ts -> Main Angular routes
47 |__ app.module.ts -> Angular root module that imports all submodules we need 50 |__ app.module.ts -> Angular root module that imports all submodules we need
48 51
49## Conventions 52## Conventions
@@ -53,11 +56,11 @@ Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [An
53## Developing 56## Developing
54 57
55 * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies) 58 * Install [the dependencies](https://github.com/Chocobozzz/PeerTube#dependencies)
56 * Run `yarn install` at the root directory to install all the dependencies 59 * Run `yarn install --pure-lockfile` at the root directory to install all the dependencies
57 * Run PostgreSQL and create the database `peertube_dev`. 60 * Run PostgreSQL and create the database `peertube_dev`.
58 * Run `npm run dev:client` to compile the client, run the server, watch client files modifications and reload modules on the fly (you don't need to refresh manually the web browser). The API listen on `localhost:9000` and the client on `localhost:3000`. 61 * Run `npm run dev:client` to compile the client, run the server, watch client files modifications and reload modules on the fly (you don't need to refresh manually the web browser). The API listen on `localhost:9000` and the client on `localhost:3000`.
59 62
60In a Angular application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionnaly a SASS file. 63In a Angular application, we create components that we put together. Each component is defined by an HTML structure, a TypeScript file and optionally a SASS file.
61If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html). 64If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html).
62 65
63## Components tree 66## Components tree
diff --git a/support/doc/client/components-tree.png b/support/doc/development/client/components-tree.png
index cd89aa02b..cd89aa02b 100644
--- a/support/doc/client/components-tree.png
+++ b/support/doc/development/client/components-tree.png
Binary files differ
diff --git a/support/doc/server/code.md b/support/doc/development/server/code.md
index 7233eaf5b..d909b0c3d 100644
--- a/support/doc/server/code.md
+++ b/support/doc/development/server/code.md
@@ -26,7 +26,7 @@ All other server files are in the [server](https://github.com/Chocobozzz/PeerTub
26 |__ controllers -> API routes/controllers files 26 |__ controllers -> API routes/controllers files
27 |__ helpers -> functions used by different part of the project (logger, utils...) 27 |__ helpers -> functions used by different part of the project (logger, utils...)
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, ActivityPub...)
30 |__ middlewares -> middlewares for controllers (requests validators, requests pagination...) 30 |__ middlewares -> middlewares for controllers (requests validators, requests pagination...)
31 |__ models -> Sequelize models for each SQL tables (videos, users, accounts...) 31 |__ models -> Sequelize models for each SQL tables (videos, users, accounts...)
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...)
diff --git a/support/doc/server/upload-video.png b/support/doc/development/server/upload-video.png
index 730e68cc4..730e68cc4 100644
--- a/support/doc/server/upload-video.png
+++ b/support/doc/development/server/upload-video.png
Binary files differ