1 # Welcome to the contributing guide for PeerTube
3 Interesting in contributing? Awesome!
7 * [Give your feedback](#give-your-feedback)
8 * [Write documentation](#write-documentation)
14 You don't need to know how to code to start contributing to PeerTube! Other
15 contributions are very valuable too, among which: you can test the software and
16 report bugs, you can give feedback on potential bugs, features that you are
17 interested in, user interface, design, decentralized architecture...
20 ## Write documentation
22 You can help to write the documentation of the REST API, code, architecture,
25 For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
26 Then, you can just open the `openapi.yaml` file in a special editor like [http://editor.swagger.io/](http://editor.swagger.io/) to easily see and edit the documentation.
29 * Routes are defined in [/server/controllers/](/server/controllers/) directory
30 * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
31 * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
36 Don't hesitate to talk about features you want to develop by creating/commenting an issue
37 before you start working on them :).
41 First, make sure that you have followed
42 [the steps](/support/doc/dependencies.md)
43 to install the dependencies.
45 Then clone the sources and install node modules:
48 $ git clone https://github.com/Chocobozzz/PeerTube
50 $ yarn install --pure-lockfile
53 Then, create a postgres database and user with the values set in the
54 `config/default.yaml` file. For instance, if you do not change the values
55 there, the following commands would create a new database called `peertube_dev`
56 and a postgres user called `peertube` with password `peertube`:
59 # sudo -u postgres createuser -P peertube
60 Enter password for new role: peertube
61 # sudo -u postgres createdb -O peertube peertube_dev
64 In dev mode, administrator username is **root** and password is **test**.
68 You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
70 To develop on the server-side:
76 Then, the server will listen on `localhost:9000`. When server source files
77 change, these are automatically recompiled and the server will automatically
78 restart. Server is in `TEST` mode so it will run requests between instances more quickly.
82 You can find a documentation of the server code/architecture
83 [here](/support/doc/development/client/code.md).
86 To develop on the client side:
92 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
93 Client files are automatically compiled on change, and the web browser will
94 reload them automatically thanks to hot module replacement.
98 This will run 3 nodes:
101 $ npm run clean:server:test
105 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
106 with the `root` as username and `test{1,2,3}` for the password.