Add client documentation
[oweals/peertube.git] / .github / CONTRIBUTING.md
1 # Welcome to the contributing guide for PeerTube
2
3 Interesting in contributing? Awesome :)
4
5 **Quick Links:**
6
7   * [Give your feedback](#give-your-feedback)
8   * [Develop on the Server side](#develop-on-the-server-side)
9   * [Develop on the Client side](#develop-on-the-client-side)
10   * [Write documentation](#write-documentation)
11
12
13 ## Give your feedback
14
15 Even if you are not a developer, or you do not want to develop on PeerTube you can give a feedback on potential bugs, features that you are interested in, user interace, design, decentralized architecture...
16
17
18 ## Develop on the Server side
19
20 The server is a web server developed with [NodeJS](https://nodejs.org)/[Express](http://expressjs.com).
21
22 Newcommer? You can find a documentation of the server code/architecture [here](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
23
24 Do not hesitate to talk about the functionnality you want to develop by creating an issue :)
25
26
27 ## Develop on the Client side
28
29 The client is a web application developed with [TypeScript](https://www.typescriptlang.org/)/[Angular2](https://angular.io/)
30
31 Newcommer? You can find a documentation of the server code/architecture [here](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
32
33
34 ## Write documentation
35
36 You can help to write the documentation of the REST API, code, architecture, demonstrations...