1 # Welcome to the contributing guide for PeerTube
3 Interesting in contributing? Awesome :)
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 * [Get started with development](#get-started-with-development)
11 * [Write documentation](#write-documentation)
16 You don't need to know how to code to start contributing to PeerTube! Other
17 contributions are very valuable too, among which: you can test the software and
18 report bugs, you can give feedback on potential bugs, features that you are
19 interested in, user interace, design, decentralized architecture...
24 ## Develop on the Server side
26 The server is a web server developed with
27 [NodeJS](https://nodejs.org)/[Express](http://expressjs.com).
29 Newcomer? You can find a documentation of the server code/architecture
30 [here](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
32 Don't hesitate to talk about features you want to develop by creating an issue
33 before you start working on them :).
36 ## Develop on the Client side
38 The client is a web application developed with
39 [TypeScript](https://www.typescriptlang.org/)/[Angular2](https://angular.io/).
41 Newcomer? You can find a documentation of the server code/architecture
42 [here](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
45 ## Get started with development
47 In this mode, the server will run requests between instances more quickly, the
48 video durations are limited to a few seconds.
52 First, make sure that you have followed the steps to install the dependencies.
54 Then, create a postgres database and user with the values set in the
55 `config/default.yaml` file. For instance, if you do not change the values
56 there, the following commands would create a new database called `peertube_dev`
57 and a postgres user called `peertube` with password `peertube`:
60 # sudo -u postgres createuser -P peertube
61 Enter password for new role: peertube
62 # sudo -u postgres createdb -O peertube peertube_dev
67 To develop on the server-side:
73 Then, the server will listen on `localhost:9000`. When server source files
74 change, these are automatically recompiled and the server will automatically
79 To develop on the client side:
85 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
86 Client files are automatically compiled on change, and the web browser will
87 reload them automatically thanks to hot module replacement.
89 **Username**: *root* <br/>
93 ## Write documentation
95 You can help to write the documentation of the REST API, code, architecture,