1 # Welcome to the contributing guide for PeerTube
3 Interested in contributing? Awesome!
5 **This guide will present you the following contribution topics:**
7 <!-- START doctoc generated TOC please keep comment here to allow auto update -->
8 <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
11 - [Translate](#translate)
12 - [Give your feedback](#give-your-feedback)
13 - [Write documentation](#write-documentation)
14 - [Improve the website](#improve-the-website)
16 - [Prerequisites](#prerequisites)
17 - [Online development](#online-development)
18 - [Server side](#server-side)
19 - [Client side](#client-side)
20 - [Client and server side](#client-and-server-side)
21 - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
22 - [Unit tests](#unit-tests)
24 - [Plugins & Themes](#plugins--themes)
26 <!-- END doctoc generated TOC please keep comment here to allow auto update -->
30 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
35 You don't need to know how to code to start contributing to PeerTube! Other
36 contributions are very valuable too, among which: you can test the software and
37 report bugs, you can give feedback on potential bugs, features that you are
38 interested in, user interface, design, decentralized architecture...
41 ## Write documentation
43 You can help to write the documentation of the REST API, code, architecture,
46 For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
47 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. You can also use [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) and run `redoc-cli serve --watch support/doc/api/openapi.yaml` to see the final result.
50 * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory
51 * Parameters validators are defined in [/server/middlewares/validators](https://github.com/Chocobozzz/PeerTube/tree/develop/server/middlewares/validators) directory
52 * Models sent/received by the controllers are defined in [/shared/models](https://github.com/Chocobozzz/PeerTube/tree/develop/shared/models) directory
55 ## Improve the website
57 PeerTube's website is [joinpeertube.org](https://joinpeertube.org), where people can learn about the project and how it works – note that it is not a PeerTube instance, but rather the project's homepage.
59 You can help us improve it too!
61 It is not hosted on GitHub but on [Framasoft](https://framasoft.org/)'s own [GitLab](https://about.gitlab.com/) instance, [FramaGit](https://framagit.org): https://framagit.org/framasoft/peertube/joinpeertube
66 Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
67 before you start working on it, and inform the community that you begin coding by claiming the issue.
69 Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
70 Once you are ready for a code review before merge, submit a Pull Request. In any case, please
71 link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
75 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
77 Make sure that you have followed
78 [the steps](/support/doc/dependencies.md)
79 to install the dependencies.
81 Fork the github repository,
82 and then clone the sources and install node modules:
85 $ git clone https://github.com/Chocobozzz/PeerTube
86 $ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
88 $ yarn install --pure-lockfile
91 Note that development is done on the `develop` branch. If you want to hack on
92 Peertube, you should switch to that branch. Also note that you have to repeat
93 the `yarn install --pure-lockfile` command.
95 When you create a new branch you should also tell to use your repo for upload
96 not default one. To do just do:
98 $ git push --set-upstream me <your branch name>
101 Then, create a postgres database and user with the values set in the
102 `config/default.yaml` file. For instance, if you do not change the values
103 there, the following commands would create a new database called `peertube_dev`
104 and a postgres user called `peertube` with password `peertube`:
107 # sudo -u postgres createuser -P peertube
108 Enter password for new role: peertube
109 # sudo -u postgres createdb -O peertube peertube_dev
112 Then enable extensions PeerTube needs:
115 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
116 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
119 In dev mode, administrator username is **root** and password is **test**.
121 ### Online development
123 You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
125 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
129 You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
131 To develop on the server-side:
137 Then, the server will listen on `localhost:9000`. When server source files
138 change, these are automatically recompiled and the server will automatically
143 You can find a documentation of the client code/architecture
144 [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
147 To develop on the client side:
153 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
154 Client files are automatically compiled on change, and the web browser will
155 reload them automatically thanks to hot module replacement.
157 ### Client and server side
159 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
160 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
161 and the web server is automatically restarted.
169 Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
170 as expected and respect the syntax conventions. They will run upon PR submission as part of our CI, but running them beforehand yourself will get you faster feedback and save CI runner time for others.
172 PeerTube mainly features backend and plugin tests, found in `server/tests`.
176 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
178 Then, we can create the databases (if they don't already exist):
181 $ sudo -u postgres createuser you_username --createdb --superuser
182 $ npm run clean:server:test
185 Build the application and run the unit/integration tests:
188 $ npm run build -- --light
192 If you just want to run 1 test (which is what you want to debug a specific test rapidly):
195 $ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts
198 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
199 Note that only instance 2 has transcoding enabled.
201 #### Testing the federation of PeerTube servers
203 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
204 Then, we can create the databases (if they don't already exist):
207 $ sudo -u postgres createuser you_username --createdb
208 $ createdb -O peertube peertube_test{1,2,3}
211 Build the application and flush the old tests data:
214 $ npm run build -- --light
215 $ npm run clean:server:test
218 This will run 3 nodes:
224 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
225 with the `root` as username and `test{1,2,3}` for the password.
227 Instance configurations are in `config/test-{1,2,3}.yaml`.
231 To test emails with PeerTube:
233 * Run [mailslurper](http://mailslurper.com/)
234 * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=test npm start`
238 See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins