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)
10 * [Improve the website](#improve-the-website)
12 * [Write a plugin or a theme](#plugins--themes)
16 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
21 You don't need to know how to code to start contributing to PeerTube! Other
22 contributions are very valuable too, among which: you can test the software and
23 report bugs, you can give feedback on potential bugs, features that you are
24 interested in, user interface, design, decentralized architecture...
27 ## Write documentation
29 You can help to write the documentation of the REST API, code, architecture,
32 For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
33 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.
36 * Routes are defined in [/server/controllers/](/server/controllers/) directory
37 * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
38 * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
41 ## Improve the website
43 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.
45 You can help us improve it too!
47 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
52 Don't hesitate to talk about features you want to develop by creating/commenting an issue
53 before you start working on them :).
57 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
59 Make sure that you have followed
60 [the steps](/support/doc/dependencies.md)
61 to install the dependencies. You'll need to install **NodeJS 10**.
63 Fork the github repository,
64 and then clone the sources and install node modules:
67 $ git clone https://github.com/Chocobozzz/PeerTube
68 $ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
70 $ yarn install --pure-lockfile
73 Note that development is done on the `develop` branch. If you want to hack on
74 Peertube, you should switch to that branch. Also note that you have to repeat
75 the `yarn install --pure-lockfile` command.
77 When you create a new branch you should also tell to use your repo for upload
78 not default one. To do just do:
80 $ git push --set-upstream me <your branch name>
83 Then, create a postgres database and user with the values set in the
84 `config/default.yaml` file. For instance, if you do not change the values
85 there, the following commands would create a new database called `peertube_dev`
86 and a postgres user called `peertube` with password `peertube`:
89 # sudo -u postgres createuser -P peertube
90 Enter password for new role: peertube
91 # sudo -u postgres createdb -O peertube peertube_dev
94 Then enable extensions PeerTube needs:
97 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
98 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
101 In dev mode, administrator username is **root** and password is **test**.
103 ### Online development
105 You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
107 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
111 You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
113 To develop on the server-side:
119 Then, the server will listen on `localhost:9000`. When server source files
120 change, these are automatically recompiled and the server will automatically
125 You can find a documentation of the client code/architecture
126 [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
129 To develop on the client side:
135 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
136 Client files are automatically compiled on change, and the web browser will
137 reload them automatically thanks to hot module replacement.
139 ### Client and server side
141 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
142 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
143 and the web server is automatically restarted.
149 ### Testing the federation of PeerTube servers
151 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
152 Then, we can create the databases (if they don't already exist):
155 $ sudo -u postgres createuser you_username --createdb
156 $ createdb -O peertube peertube_test{1,2,3}
159 Build the application and flush the old tests data:
162 $ npm run build -- --light
163 $ npm run clean:server:test
166 This will run 3 nodes:
172 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
173 with the `root` as username and `test{1,2,3}` for the password.
175 Instance configurations are in `config/test-{1,2,3}.yaml`.
179 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
181 Then, we can create the databases (if they don't already exist):
184 $ sudo -u postgres createuser you_username --createdb --superuser
185 $ npm run clean:server:test
188 Build the application and run the unit/integration tests:
191 $ npm run build -- --light
195 If you just want to run 1 test:
198 $ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts
201 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
202 Note that only instance 2 has transcoding enabled.
206 See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins