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 Don't hesitate to talk about features you want to develop by creating/commenting an issue
67 before you start working on them :).
71 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
73 Make sure that you have followed
74 [the steps](/support/doc/dependencies.md)
75 to install the dependencies.
77 Fork the github repository,
78 and then clone the sources and install node modules:
81 $ git clone https://github.com/Chocobozzz/PeerTube
82 $ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
84 $ yarn install --pure-lockfile
87 Note that development is done on the `develop` branch. If you want to hack on
88 Peertube, you should switch to that branch. Also note that you have to repeat
89 the `yarn install --pure-lockfile` command.
91 When you create a new branch you should also tell to use your repo for upload
92 not default one. To do just do:
94 $ git push --set-upstream me <your branch name>
97 Then, create a postgres database and user with the values set in the
98 `config/default.yaml` file. For instance, if you do not change the values
99 there, the following commands would create a new database called `peertube_dev`
100 and a postgres user called `peertube` with password `peertube`:
103 # sudo -u postgres createuser -P peertube
104 Enter password for new role: peertube
105 # sudo -u postgres createdb -O peertube peertube_dev
108 Then enable extensions PeerTube needs:
111 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
112 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
115 In dev mode, administrator username is **root** and password is **test**.
117 ### Online development
119 You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
121 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
125 You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
127 To develop on the server-side:
133 Then, the server will listen on `localhost:9000`. When server source files
134 change, these are automatically recompiled and the server will automatically
139 You can find a documentation of the client code/architecture
140 [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
143 To develop on the client side:
149 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
150 Client files are automatically compiled on change, and the web browser will
151 reload them automatically thanks to hot module replacement.
153 ### Client and server side
155 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
156 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
157 and the web server is automatically restarted.
163 ### Testing the federation of PeerTube servers
165 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
166 Then, we can create the databases (if they don't already exist):
169 $ sudo -u postgres createuser you_username --createdb
170 $ createdb -O peertube peertube_test{1,2,3}
173 Build the application and flush the old tests data:
176 $ npm run build -- --light
177 $ npm run clean:server:test
180 This will run 3 nodes:
186 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
187 with the `root` as username and `test{1,2,3}` for the password.
189 Instance configurations are in `config/test-{1,2,3}.yaml`.
193 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
195 Then, we can create the databases (if they don't already exist):
198 $ sudo -u postgres createuser you_username --createdb --superuser
199 $ npm run clean:server:test
202 Build the application and run the unit/integration tests:
205 $ npm run build -- --light
209 If you just want to run 1 test:
212 $ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts
215 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
216 Note that only instance 2 has transcoding enabled.
220 To test emails with PeerTube:
222 * Run [mailslurper](http://mailslurper.com/)
223 * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=test npm start`
227 See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins