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

# Client code documentation

The client is a HTML/CSS/JavaScript web application (single page application -> SPA) developed with [TypeScript](https://www.typescriptlang.org/)/[Angular](https://angular.io/).


## Technologies

  * [TypeScript](https://www.typescriptlang.org/) -> Language
  * [Angular](https://angular.io) -> JavaScript framework
  * [SASS](http://sass-lang.com/) -> CSS framework
  * [Webpack](https://webpack.js.org/) -> Source builder (compile TypeScript, SASS files, bundle them...)
  * [Bootstrap](http://getbootstrap.com/) -> CSS framework
  * [WebTorrent](https://webtorrent.io/) -> JavaScript library to make P2P in the browser
  * [VideoJS](http://videojs.com/) -> JavaScript player framework


## Files

The client files are in the `client` directory. The Webpack 2 configurations files are in `client/config` and the source files in `client/src`.
The client modules description are in the [client/package.json](/client/package.json). There are many modules that are used to compile the web application in development or production mode.
Here is the description of the useful `client` files directory:

    tslint.json   -> TypeScript linter rules
    tsconfig.json -> TypeScript configuration for the compilation
    .bootstraprc  -> Bootstrap configuration file (which module we need)
    config        -> Webpack configuration files
    src
    |__ app          -> TypeScript files for Angular application
    |__ assets       -> static files (images...)
    |__ sass         -> SASS files that are global for the application
    |__ standalone   -> files outside the Angular application (embed HTML page...)
    |__ index.html   -> root HTML file for our Angular application
    |__ main.ts      -> Main TypeScript file that boostraps our Angular application
    |__ polyfills.ts -> Polyfills imports (ES 2015...)

Details of the Angular application file structure. It tries to follow [the official Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html).

    app
    |__ +admin                       -> Admin components (followers, users...)
    |__ account                      -> Account components (password change...)
    |__ core                         -> Core components/services
    |__ header                       -> Header components (logo, search...)
    |__ login                        -> Login component
    |__ menu                         -> Menu component (on the left)
    |__ shared                       -> Shared components/services (search component, REST services...)
    |__ signup                       -> Signup form
    |__ videos                       -> Video components (list, watch, upload...)
    |__ app.component.{html,scss,ts} -> Main application component
    |__ app-routing.module.ts        -> Main Angular routes
    |__ app.module.ts                -> Angular root module that imports all submodules we need

## Conventions

Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html).

## Concepts

In 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.
If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html).

## Components tree

![Components tree](/support/doc/client/development/components-tree.png)

## Newcomers

The main client component is `app.component.ts`. You can begin to look at this file. Then you could navigate in the different submodules to see how components are built.
Commit	Line	Data
35a12fee C	1	# Client code documentation
35a12fee C	2
69f616ab	3	The client is a HTML/CSS/JavaScript web application (single page application -> SPA) developed with [TypeScript](https://www.typescriptlang.org/)/[Angular](https://angular.io/).
35a12fee C	4
	5
	6	## Technologies
	7
	8	* [TypeScript](https://www.typescriptlang.org/) -> Language
69f616ab	9	* [Angular](https://angular.io) -> JavaScript framework
35a12fee	10	* [SASS](http://sass-lang.com/) -> CSS framework
8b99b0c1	11	* [Webpack](https://webpack.js.org/) -> Source builder (compile TypeScript, SASS files, bundle them...)
35a12fee C	12	* [Bootstrap](http://getbootstrap.com/) -> CSS framework
	13	* [WebTorrent](https://webtorrent.io/) -> JavaScript library to make P2P in the browser
	14	* [VideoJS](http://videojs.com/) -> JavaScript player framework
	15
	16
	17	## Files
	18
	19	The client files are in the `client` directory. The Webpack 2 configurations files are in `client/config` and the source files in `client/src`.
afe81767	20	The client modules description are in the [client/package.json](/client/package.json). There are many modules that are used to compile the web application in development or production mode.
35a12fee C	21	Here is the description of the useful `client` files directory:
	22
	23	tslint.json -> TypeScript linter rules
	24	tsconfig.json -> TypeScript configuration for the compilation
	25	.bootstraprc -> Bootstrap configuration file (which module we need)
	26	config -> Webpack configuration files
	27	src
69f616ab	28	\|__ app -> TypeScript files for Angular application
35a12fee C	29	\|__ assets -> static files (images...)
	30	\|__ sass -> SASS files that are global for the application
	31	\|__ standalone -> files outside the Angular application (embed HTML page...)
69f616ab C	32	\|__ index.html -> root HTML file for our Angular application
69f616ab C	33	\|__ main.ts -> Main TypeScript file that boostraps our Angular application
35a12fee	34	\|__ polyfills.ts -> Polyfills imports (ES 2015...)
35a12fee	35
69f616ab	36	Details of the Angular application file structure. It tries to follow [the official Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html).
35a12fee C	37
35a12fee C	38	app
339632b4	39	\|__ +admin -> Admin components (followers, users...)
35a12fee	40	\|__ account -> Account components (password change...)
35a12fee	41	\|__ core -> Core components/services
339632b4	42	\|__ header -> Header components (logo, search...)
35a12fee	43	\|__ login -> Login component
339632b4	44	\|__ menu -> Menu component (on the left)
35a12fee	45	\|__ shared -> Shared components/services (search component, REST services...)
339632b4	46	\|__ signup -> Signup form
35a12fee C	47	\|__ videos -> Video components (list, watch, upload...)
35a12fee C	48	\|__ app.component.{html,scss,ts} -> Main application component
339632b4	49	\|__ app-routing.module.ts -> Main Angular routes
69f616ab	50	\|__ app.module.ts -> Angular root module that imports all submodules we need
35a12fee C	51
	52	## Conventions
	53
69f616ab	54	Uses [TSLint](https://palantir.github.io/tslint/) for TypeScript linting and [Angular styleguide](https://angular.io/docs/ts/latest/guide/style-guide.html).
35a12fee	55
63bfad7e	56	## Concepts
35a12fee	57
339632b4	58	In 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.
69f616ab	59	If you are not familiar with Angular I recommend you to read the [quickstart guide](https://angular.io/docs/ts/latest/quickstart.html).
35a12fee C	60
	61	## Components tree
	62
afe81767	63	![Components tree](/support/doc/client/development/components-tree.png)
35a12fee C	64
	65	## Newcomers
	66
	67	The main client component is `app.component.ts`. You can begin to look at this file. Then you could navigate in the different submodules to see how components are built.