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