.github/CONTRIBUTING.md

   1 # Welcome to the contributing guide for PeerTube
   2
   3 Interested in contributing? Awesome!
   4
   5 **Quick Links:**
   6
   7   * [Translate](#translate)
   8   * [Give your feedback](#give-your-feedback)
   9   * [Write documentation](#write-documentation)
  10   * [Develop](#develop)
  11   * [Improve the website](#improve-the-website)
  12
  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
  18 ## Give your feedback
  19
  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
  23 interested in, user interface, design, decentralized architecture...
  24
  25
  26 ## Write documentation
  27
  28 You can help to write the documentation of the REST API, code, architecture,
  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
  39
  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
  49 ## Develop
  50
  51 Don't hesitate to talk about features you want to develop by creating/commenting an issue
  52 before you start working on them :).
  53
  54 ### Prerequisites
  55
  56 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
  57
  58 Make sure that you have followed
  59 [the steps](/support/doc/dependencies.md)
  60 to install the dependencies.
  61
  62 Then clone the sources and install node modules:
  63
  64 ```
  65 $ git clone https://github.com/Chocobozzz/PeerTube
  66 $ cd PeerTube
  67 $ yarn install --pure-lockfile
  68 ```
  69
  70 Note that development is done on the `develop` branch. If you want to hack on
  71 Peertube, you should switch to that branch. Also note that you have to repeat
  72 the `yarn install --pure-lockfile` command.
  73
  74 Then, create a postgres database and user with the values set in the
  75 `config/default.yaml` file. For instance, if you do not change the values
  76 there, the following commands would create a new database called `peertube_dev`
  77 and a postgres user called `peertube` with password `peertube`:
  78
  79 ```
  80 # sudo -u postgres createuser -P peertube
  81 Enter password for new role: peertube
  82 # sudo -u postgres createdb -O peertube peertube_dev
  83 ```
  84
  85 Then enable extensions PeerTube needs:
  86
  87 ```
  88 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
  89 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
  90 ```
  91
  92 In dev mode, administrator username is **root** and password is **test**.
  93
  94 ### Server side
  95
  96 You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
  97
  98 To develop on the server-side:
  99
 100 ```
 101 $ npm run dev:server
 102 ```
 103
 104 Then, the server will listen on `localhost:9000`. When server source files
 105 change, these are automatically recompiled and the server will automatically
 106 restart.
 107
 108 ### Client side
 109
 110 You can find a documentation of the server code/architecture
 111 [here](/support/doc/development/client/code.md).
 112
 113
 114 To develop on the client side:
 115
 116 ```
 117 $ npm run dev:client
 118 ```
 119
 120 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 121 Client files are automatically compiled on change, and the web browser will
 122 reload them automatically thanks to hot module replacement.
 123
 124 ### Client and server side
 125
 126 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 127 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
 128 and the web server is automatically restarted.
 129
 130 ```
 131 $ npm run dev
 132 ```
 133
 134 Depending on your OS, you may face the following error :
 135 ```
 136 $ [nodemon] Internal watch failed: ENOSPC: no space left on device, watch '/PeerTube/dist'
 137 ```
 138
 139 This is due to your system's limit on the number of files you can monitor for live-checking changes. For example, Ubuntu uses inotify and this limit is set to 8192. Then you need to change this limit :
 140 ```
 141 echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
 142 ```
 143
 144 See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
 145
 146 ### Configurations for VPS
 147
 148 If you want to develop using a Virtual Private Server, you will need to configure the url for the API and the hostname. First, you need to edit the [client/src/environments/environment.hmr.ts](client/src/environments/environment.hmr.ts) file by replacing the `localhost` in the `apiUrl` field with the address of your VPS. Thus, the [Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/) from Webpack will be set up for developping with live-reload.
 149
 150 Next, you will need to edit the [config/default.yaml](config/default.yaml) file. Just replace the `localhost` with your VPS address in the following `hostname` fields :
 151 ```
 152 listen:
 153   hostname: 'my-vps-address.net'
 154   port: 9000
 155
 156 webserver:
 157   https: false
 158   hostname: 'my-vps-address.net'
 159   port: 9000
 160 ```
 161
 162 Then, you just need to listen to `https://my-vps-address.net:3000/` in your web browser.
 163
 164 ### Federation
 165
 166 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 167 Then, we can create the databases (if they don't already exist):
 168
 169 ```
 170 $ sudo -u postgres createuser you_username --createdb
 171 $ createdb -O peertube peertube_test{1,2,3}
 172 ```
 173
 174 Build the application and flush the old tests data:
 175
 176 ```
 177 $ npm run build
 178 $ npm run clean:server:test
 179 ```
 180
 181 This will run 3 nodes:
 182
 183 ```
 184 $ npm run play
 185 ```
 186
 187 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 188 with the `root` as username and `test{1,2,3}` for the password.
 189
 190 Instance configurations are in `config/test-{1,2,3}.yaml`.
 191
 192 ### Unit tests
 193
 194 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 195
 196 Then, we can create the databases (if they don't already exist):
 197
 198 ```
 199 $ sudo -u postgres createuser you_username --createdb --superuser
 200 $ createdb -O peertube peertube_test{1,2,3,4,5,6}
 201 ```
 202
 203 Build the application and run the unit/integration tests:
 204
 205 ```
 206 $ npm run build
 207 $ npm test
 208 ```
 209
 210 If you just want to run 1 test:
 211
 212 ```
 213 $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
 214 ```
 215
 216 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 217 Note that only instance 2 has transcoding enabled.