1 # Welcome to the contributing guide for PeerTube
3 Interested in contributing? Awesome!
5 **This guide will present you the following contribution topics:**
7 * [Translate](#translate)
8 * [Give your feedback](#give-your-feedback)
9 * [Write documentation](#write-documentation)
11 * [Improve the website](#improve-the-website)
15 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
20 You don't need to know how to code to start contributing to PeerTube! Other
21 contributions are very valuable too, among which: you can test the software and
22 report bugs, you can give feedback on potential bugs, features that you are
23 interested in, user interface, design, decentralized architecture...
26 ## Write documentation
28 You can help to write the documentation of the REST API, code, architecture,
31 For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
32 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.
35 * Routes are defined in [/server/controllers/](/server/controllers/) directory
36 * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
37 * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
40 ## Improve the website
42 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.
44 You can help us improve it too!
46 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
51 Don't hesitate to talk about features you want to develop by creating/commenting an issue
52 before you start working on them :).
56 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
58 Make sure that you have followed
59 [the steps](/support/doc/dependencies.md)
60 to install the dependencies.
62 Fork the github repository,
63 and then clone the sources and install node modules:
66 $ git clone https://github.com/Chocobozzz/PeerTube
67 $ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
69 $ yarn install --pure-lockfile
72 Note that development is done on the `develop` branch. If you want to hack on
73 Peertube, you should switch to that branch. Also note that you have to repeat
74 the `yarn install --pure-lockfile` command.
76 When you create a new branch you should also tell to use your repo for upload
77 not default one. To do just do:
79 $ git push --set-upstream me <your branch name>
82 Then, create a postgres database and user with the values set in the
83 `config/default.yaml` file. For instance, if you do not change the values
84 there, the following commands would create a new database called `peertube_dev`
85 and a postgres user called `peertube` with password `peertube`:
88 # sudo -u postgres createuser -P peertube
89 Enter password for new role: peertube
90 # sudo -u postgres createdb -O peertube peertube_dev
93 Then enable extensions PeerTube needs:
96 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
97 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
100 In dev mode, administrator username is **root** and password is **test**.
102 ### Online development
104 You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
106 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
110 You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
112 To develop on the server-side:
118 Then, the server will listen on `localhost:9000`. When server source files
119 change, these are automatically recompiled and the server will automatically
124 You can find a documentation of the client code/architecture
125 [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
128 To develop on the client side:
134 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
135 Client files are automatically compiled on change, and the web browser will
136 reload them automatically thanks to hot module replacement.
138 ### Client and server side
140 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
141 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
142 and the web server is automatically restarted.
148 ### Testing the federation of PeerTube servers
150 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
151 Then, we can create the databases (if they don't already exist):
154 $ sudo -u postgres createuser you_username --createdb
155 $ createdb -O peertube peertube_test{1,2,3}
158 Build the application and flush the old tests data:
161 $ npm run build -- --light
162 $ npm run clean:server:test
165 This will run 3 nodes:
171 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
172 with the `root` as username and `test{1,2,3}` for the password.
174 Instance configurations are in `config/test-{1,2,3}.yaml`.
178 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
180 Then, we can create the databases (if they don't already exist):
183 $ sudo -u postgres createuser you_username --createdb --superuser
184 $ createdb -O peertube peertube_test{1,2,3,4,5,6}
187 Build the application and run the unit/integration tests:
194 If you just want to run 1 test:
197 $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
200 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
201 Note that only instance 2 has transcoding enabled.