.github/CONTRIBUTING.md

   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   * [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 ### Online development
  95
  96 You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
  97
  98 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
  99
 100 ### Server side
 101
 102 You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
 103
 104 To develop on the server-side:
 105
 106 ```
 107 $ npm run dev:server
 108 ```
 109
 110 Then, the server will listen on `localhost:9000`. When server source files
 111 change, these are automatically recompiled and the server will automatically
 112 restart.
 113
 114 ### Client side
 115
 116 You can find a documentation of the server code/architecture
 117 [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
 118
 119
 120 To develop on the client side:
 121
 122 ```
 123 $ npm run dev:client
 124 ```
 125
 126 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 127 Client files are automatically compiled on change, and the web browser will
 128 reload them automatically thanks to hot module replacement.
 129
 130 ### Client and server side
 131
 132 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 133 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
 134 and the web server is automatically restarted.
 135
 136 ```
 137 $ npm run dev
 138 ```
 139
 140 ### Testing the federation of PeerTube servers
 141
 142 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 143 Then, we can create the databases (if they don't already exist):
 144
 145 ```
 146 $ sudo -u postgres createuser you_username --createdb
 147 $ createdb -O peertube peertube_test{1,2,3}
 148 ```
 149
 150 Build the application and flush the old tests data:
 151
 152 ```
 153 $ npm run build -- --light
 154 $ npm run clean:server:test
 155 ```
 156
 157 This will run 3 nodes:
 158
 159 ```
 160 $ npm run play
 161 ```
 162
 163 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 164 with the `root` as username and `test{1,2,3}` for the password.
 165
 166 Instance configurations are in `config/test-{1,2,3}.yaml`.
 167
 168 ### Unit tests
 169
 170 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 171
 172 Then, we can create the databases (if they don't already exist):
 173
 174 ```
 175 $ sudo -u postgres createuser you_username --createdb --superuser
 176 $ createdb -O peertube peertube_test{1,2,3,4,5,6}
 177 ```
 178
 179 Build the application and run the unit/integration tests:
 180
 181 ```
 182 $ npm run build
 183 $ npm test
 184 ```
 185
 186 If you just want to run 1 test:
 187
 188 ```
 189 $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
 190 ```
 191
 192 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 193 Note that only instance 2 has transcoding enabled.