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