]>
Commit | Line | Data |
---|---|---|
7a7edb72 C |
1 | # Welcome to the contributing guide for PeerTube |
2 | ||
71607e4a | 3 | Interested in contributing? Awesome! |
7a7edb72 | 4 | |
e2266e4f | 5 | **This guide will present you the following contribution topics:** |
7a7edb72 | 6 | |
17b07dc5 C |
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 --> | |
9 | ||
10 | ||
11 | - [Translate](#translate) | |
12 | - [Give your feedback](#give-your-feedback) | |
13 | - [Write documentation](#write-documentation) | |
14 | - [Improve the website](#improve-the-website) | |
15 | - [Develop](#develop) | |
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) | |
23 | - [Emails](#emails) | |
24 | - [Plugins & Themes](#plugins--themes) | |
25 | ||
26 | <!-- END doctoc generated TOC please keep comment here to allow auto update --> | |
7a7edb72 | 27 | |
6a1787c1 C |
28 | ## Translate |
29 | ||
30 | You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how. | |
31 | ||
32 | ||
7a7edb72 C |
33 | ## Give your feedback |
34 | ||
e755a63a BB |
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 | |
63bfad7e | 38 | interested in, user interface, design, decentralized architecture... |
7a7edb72 C |
39 | |
40 | ||
63bfad7e | 41 | ## Write documentation |
7a7edb72 | 42 | |
63bfad7e | 43 | You can help to write the documentation of the REST API, code, architecture, |
d59a8da8 C |
44 | demonstrations. |
45 | ||
0ceadb35 | 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. |
17b07dc5 | 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. |
d59a8da8 C |
48 | |
49 | Some hints: | |
0ceadb35 C |
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 | |
d59a8da8 | 53 | |
7a7edb72 | 54 | |
0e62b72b TK |
55 | ## Improve the website |
56 | ||
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. | |
58 | ||
59 | You can help us improve it too! | |
60 | ||
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 | |
62 | ||
63 | ||
63bfad7e | 64 | ## Develop |
7a7edb72 | 65 | |
7193ad10 | 66 | Don't hesitate to talk about features you want to develop by creating/commenting an issue |
e755a63a | 67 | before you start working on them :). |
7a7edb72 | 68 | |
63bfad7e | 69 | ### Prerequisites |
7a7edb72 | 70 | |
a43e2182 | 71 | First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes. |
72 | ||
0cfcbae8 JK |
73 | Make sure that you have followed |
74 | [the steps](/support/doc/dependencies.md) | |
6676056a | 75 | to install the dependencies. |
e755a63a | 76 | |
e6b04e0e | 77 | Fork the github repository, |
78 | and then clone the sources and install node modules: | |
e755a63a | 79 | |
afe81767 | 80 | ``` |
b30acc0e J |
81 | $ git clone https://github.com/Chocobozzz/PeerTube |
82 | $ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git | |
63bfad7e C |
83 | $ cd PeerTube |
84 | $ yarn install --pure-lockfile | |
85 | ``` | |
e755a63a | 86 | |
dd07afa5 FA |
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. | |
90 | ||
b30acc0e J |
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: | |
93 | ``` | |
94 | $ git push --set-upstream me <your branch name> | |
95 | ``` | |
96 | ||
e755a63a BB |
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`: | |
101 | ||
afe81767 | 102 | ``` |
63bfad7e C |
103 | # sudo -u postgres createuser -P peertube |
104 | Enter password for new role: peertube | |
105 | # sudo -u postgres createdb -O peertube peertube_dev | |
e755a63a BB |
106 | ``` |
107 | ||
dd07afa5 FA |
108 | Then enable extensions PeerTube needs: |
109 | ||
110 | ``` | |
111 | $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev | |
112 | $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev | |
113 | ``` | |
114 | ||
63bfad7e C |
115 | In dev mode, administrator username is **root** and password is **test**. |
116 | ||
0cfcbae8 JK |
117 | ### Online development |
118 | ||
119 | You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub: | |
120 | ||
121 | [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube) | |
122 | ||
e755a63a BB |
123 | ### Server side |
124 | ||
46e9407c | 125 | You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code). |
63bfad7e | 126 | |
e755a63a BB |
127 | To develop on the server-side: |
128 | ||
afe81767 | 129 | ``` |
63bfad7e | 130 | $ npm run dev:server |
e755a63a BB |
131 | ``` |
132 | ||
133 | Then, the server will listen on `localhost:9000`. When server source files | |
134 | change, these are automatically recompiled and the server will automatically | |
19096851 | 135 | restart. |
e755a63a BB |
136 | |
137 | ### Client side | |
138 | ||
838f4a79 | 139 | You can find a documentation of the client code/architecture |
46e9407c | 140 | [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code). |
63bfad7e C |
141 | |
142 | ||
e755a63a BB |
143 | To develop on the client side: |
144 | ||
afe81767 | 145 | ``` |
63bfad7e | 146 | $ npm run dev:client |
e755a63a BB |
147 | ``` |
148 | ||
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. | |
7a7edb72 | 152 | |
19096851 C |
153 | ### Client and server side |
154 | ||
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. | |
158 | ||
159 | ``` | |
160 | $ npm run dev | |
161 | ``` | |
162 | ||
e2266e4f | 163 | ### Testing the federation of PeerTube servers |
35a12fee | 164 | |
a9ab599e C |
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): | |
a2897212 C |
167 | |
168 | ``` | |
a9ab599e C |
169 | $ sudo -u postgres createuser you_username --createdb |
170 | $ createdb -O peertube peertube_test{1,2,3} | |
a2897212 C |
171 | ``` |
172 | ||
173 | Build the application and flush the old tests data: | |
7a7edb72 | 174 | |
afe81767 | 175 | ``` |
9ba1d64b | 176 | $ npm run build -- --light |
63bfad7e | 177 | $ npm run clean:server:test |
a2897212 C |
178 | ``` |
179 | ||
180 | This will run 3 nodes: | |
181 | ||
182 | ``` | |
63bfad7e C |
183 | $ npm run play |
184 | ``` | |
7a7edb72 | 185 | |
63bfad7e C |
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. | |
19096851 | 188 | |
dbe868c0 | 189 | Instance configurations are in `config/test-{1,2,3}.yaml`. |
19096851 C |
190 | |
191 | ### Unit tests | |
192 | ||
a9ab599e | 193 | Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user. |
6cca7360 | 194 | |
a9ab599e | 195 | Then, we can create the databases (if they don't already exist): |
a2897212 C |
196 | |
197 | ``` | |
6d492e56 | 198 | $ sudo -u postgres createuser you_username --createdb --superuser |
50b4dcce | 199 | $ npm run clean:server:test |
a2897212 C |
200 | ``` |
201 | ||
202 | Build the application and run the unit/integration tests: | |
19096851 C |
203 | |
204 | ``` | |
50b4dcce | 205 | $ npm run build -- --light |
19096851 C |
206 | $ npm test |
207 | ``` | |
76434ec8 C |
208 | |
209 | If you just want to run 1 test: | |
210 | ||
211 | ``` | |
e5426b3f | 212 | $ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts |
76434ec8 | 213 | ``` |
dbe868c0 C |
214 | |
215 | Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. | |
a43e2182 | 216 | Note that only instance 2 has transcoding enabled. |
bfa1a32b | 217 | |
17b07dc5 C |
218 | ### Emails |
219 | ||
220 | To test emails with PeerTube: | |
221 | ||
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` | |
224 | ||
bfa1a32b C |
225 | ## Plugins & Themes |
226 | ||
227 | See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins |