CONTRIBUTING.md 8.68 KB
Newer Older
Chocobozzz's avatar
Chocobozzz committed
1
2
# Welcome to the contributing guide for PeerTube

Rigel Kent's avatar
Rigel Kent committed
3
Interested in contributing? Awesome!
Chocobozzz's avatar
Chocobozzz committed
4

5
**This guide will present you the following contribution topics:**
Chocobozzz's avatar
Chocobozzz committed
6

Chocobozzz's avatar
Chocobozzz committed
7
8
9
10
11
12
13
14
15
16
17
18
19
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->

- [Translate](#translate)
- [Give your feedback](#give-your-feedback)
- [Write documentation](#write-documentation)
- [Improve the website](#improve-the-website)
- [Develop](#develop)
  - [Prerequisites](#prerequisites)
  - [Online development](#online-development)
  - [Server side](#server-side)
  - [Client side](#client-side)
  - [Client and server side](#client-and-server-side)
20
21
  - [RTL layout](#rtl-layout)
  - [Testing](#testing)
Chocobozzz's avatar
Chocobozzz committed
22
    - [Unit/integration tests](#unitintegration-tests)
23
    - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
Chocobozzz's avatar
Chocobozzz committed
24
25
26
27
  - [Emails](#emails)
- [Plugins & Themes](#plugins--themes)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->
Chocobozzz's avatar
Chocobozzz committed
28

Chocobozzz's avatar
Chocobozzz committed
29
30
31
32
33
## Translate

You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.


Chocobozzz's avatar
Chocobozzz committed
34
35
## Give your feedback

Benjamin Bouvier's avatar
Benjamin Bouvier committed
36
37
38
You don't need to know how to code to start contributing to PeerTube! Other
contributions are very valuable too, among which: you can test the software and
report bugs, you can give feedback on potential bugs, features that you are
39
interested in, user interface, design, decentralized architecture...
Chocobozzz's avatar
Chocobozzz committed
40
41


42
## Write documentation
Chocobozzz's avatar
Chocobozzz committed
43

44
You can help to write the documentation of the REST API, code, architecture,
Chocobozzz's avatar
Chocobozzz committed
45
46
demonstrations.

47
For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
Chocobozzz's avatar
Chocobozzz committed
48
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.
Chocobozzz's avatar
Chocobozzz committed
49
50

Some hints:
51
52
53
 * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory
 * Parameters validators are defined in [/server/middlewares/validators](https://github.com/Chocobozzz/PeerTube/tree/develop/server/middlewares/validators) directory
 * Models sent/received by the controllers are defined in [/shared/models](https://github.com/Chocobozzz/PeerTube/tree/develop/shared/models) directory
Chocobozzz's avatar
Chocobozzz committed
54

Chocobozzz's avatar
Chocobozzz committed
55

56
57
58
59
60
61
62
63
64
## Improve the website

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.

You can help us improve it too!

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


65
## Develop
Chocobozzz's avatar
Chocobozzz committed
66

Rigel Kent's avatar
Rigel Kent committed
67
68
69
70
71
72
Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
before you start working on it, and inform the community that you begin coding by claiming the issue.

Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
Once you are ready for a code review before merge, submit a Pull Request. In any case, please
link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
Chocobozzz's avatar
Chocobozzz committed
73

74
### Prerequisites
Chocobozzz's avatar
Chocobozzz committed
75

76
77
First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.

78
1) Make sure that you have followed
79
[the steps](/support/doc/dependencies.md)
80
to install the dependencies.
81
82
83
1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests.
1) Fork the Github repository.
1) Run the following commands.
Chocobozzz's avatar
Chocobozzz committed
84
```
85
$ git clone https://github.com/Chocobozzz/PeerTube
86
$ cd PeerTube
87
$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
88
89
$ yarn install --pure-lockfile
```
Benjamin Bouvier's avatar
Benjamin Bouvier committed
90

91
92
93
94
Note that development is done on the `develop` branch. If you want to hack on
Peertube, you should switch to that branch. Also note that you have to repeat
the `yarn install --pure-lockfile` command.

95
96
97
98
99
100
When you create a new branch you should also tell to use your repo for upload
not default one. To do just do:
```
$ git push --set-upstream me <your branch name>
```

Benjamin Bouvier's avatar
Benjamin Bouvier committed
101
102
103
104
105
Then, create a postgres database and user with the values set in the
`config/default.yaml` file. For instance, if you do not change the values
there, the following commands would create a new database called `peertube_dev`
and a postgres user called `peertube` with password `peertube`:

Chocobozzz's avatar
Chocobozzz committed
106
```
107
108
109
# sudo -u postgres createuser -P peertube
Enter password for new role: peertube
# sudo -u postgres createdb -O peertube peertube_dev
Benjamin Bouvier's avatar
Benjamin Bouvier committed
110
111
```

112
113
114
115
116
117
118
Then enable extensions PeerTube needs:

```
$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
```

119
120
121
Peertube also requires a running redis server, no special setup is needed for
this.

122
123
In dev mode, administrator username is **root** and password is **test**.

124
125
126
127
128
129
### Online development

You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)

Benjamin Bouvier's avatar
Benjamin Bouvier committed
130
131
### Server side

132
You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/contribute-architecture?id=server-code).
133

Benjamin Bouvier's avatar
Benjamin Bouvier committed
134
135
To develop on the server-side:

Chocobozzz's avatar
Chocobozzz committed
136
```
137
$ npm run dev:server
Benjamin Bouvier's avatar
Benjamin Bouvier committed
138
139
140
141
```

Then, the server will listen on `localhost:9000`. When server source files
change, these are automatically recompiled and the server will automatically
Chocobozzz's avatar
Chocobozzz committed
142
restart.
Benjamin Bouvier's avatar
Benjamin Bouvier committed
143
144
145

### Client side

146
You can find a documentation of the client code/architecture
147
[here](https://docs.joinpeertube.org/contribute-architecture?id=client-code).
148
149


Benjamin Bouvier's avatar
Benjamin Bouvier committed
150
151
To develop on the client side:

Chocobozzz's avatar
Chocobozzz committed
152
```
153
$ npm run dev:client
Benjamin Bouvier's avatar
Benjamin Bouvier committed
154
155
156
157
158
```

The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
Client files are automatically compiled on change, and the web browser will
reload them automatically thanks to hot module replacement.
Chocobozzz's avatar
Chocobozzz committed
159

Chocobozzz's avatar
Chocobozzz committed
160
161
162
163
164
165
166
167
168
169
### Client and server side

The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
and the web server is automatically restarted.

```
$ npm run dev
```

Chocobozzz's avatar
Chocobozzz committed
170
171
172
173
174
175
176
177
### RTL layout

To test RTL layout using `ar` locale:

```
$ npm run dev -- --ar-locale
```

Rigel Kent's avatar
Rigel Kent committed
178
179
### Testing

Chocobozzz's avatar
Chocobozzz committed
180
181
#### Unit/integration tests

Rigel Kent's avatar
Rigel Kent committed
182
183
184
Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
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.

Chocobozzz's avatar
Chocobozzz committed
185
See the [dedicated documentation](/support/doc/development/tests.md) to run tests locally.
Chocobozzz's avatar
Chocobozzz committed
186

Rigel Kent's avatar
Rigel Kent committed
187
#### Testing the federation of PeerTube servers
Chocobozzz's avatar
Chocobozzz committed
188

189
190
Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
Then, we can create the databases (if they don't already exist):
191
192

```
Rigel Kent's avatar
Rigel Kent committed
193
194
$ sudo -u postgres createuser you_username --createdb
$ createdb -O peertube peertube_test{1,2,3}
195
196
```

Rigel Kent's avatar
Rigel Kent committed
197
Build the application and flush the old tests data:
Chocobozzz's avatar
Chocobozzz committed
198
199

```
200
$ npm run build
Rigel Kent's avatar
Rigel Kent committed
201
$ npm run clean:server:test
Chocobozzz's avatar
Chocobozzz committed
202
```
Chocobozzz's avatar
Chocobozzz committed
203

204
To run 3 nodes:
Chocobozzz's avatar
Chocobozzz committed
205
206

```
207
208
209
$ NODE_APP_INSTANCE=1 NODE_ENV=test npm start
$ NODE_APP_INSTANCE=2 NODE_ENV=test npm start
$ NODE_APP_INSTANCE=3 NODE_ENV=test npm start
Chocobozzz's avatar
Chocobozzz committed
210
```
211

Rigel Kent's avatar
Rigel Kent committed
212
213
214
215
Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
with the `root` as username and `test{1,2,3}` for the password.

Instance configurations are in `config/test-{1,2,3}.yaml`.
Chocobozzz's avatar
Chocobozzz committed
216

Chocobozzz's avatar
Chocobozzz committed
217
218
219
220
221
### Emails

To test emails with PeerTube:

 * Run [mailslurper](http://mailslurper.com/)
222
 * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server`
Chocobozzz's avatar
Chocobozzz committed
223

Chocobozzz's avatar
Chocobozzz committed
224
225
226
227
228
229
230
231
232
233
234
235
### Environment variables

PeerTube can be configured using environment variables.
See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables

Additionally to these ones, we provide some environment for dev/test purpose:

 * `PRODUCTION_CONSTANTS=true`: in `NODE_ENV=dev` or `NODE_ENV=test` PeerTube customizes some constants. To prevent this behaviour, you can set `PRODUCTION_CONSTANTS` env to
 `true`
 * `PEERTUBE_LOCAL_CONFIG`: directory to find the local configuration file (used by web admin)
 * `NODE_DB_LOG=false`: disable SQL request logging

Chocobozzz's avatar
Chocobozzz committed
236
237
## Plugins & Themes

238
See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins