.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   * [Troubleshooting](#troubleshooting)
  13   * [Tutorials](#tutorials)
  14
  15 ## Translate
  16
  17 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
  18
  19
  20 ## Give your feedback
  21
  22 You don't need to know how to code to start contributing to PeerTube! Other
  23 contributions are very valuable too, among which: you can test the software and
  24 report bugs, you can give feedback on potential bugs, features that you are
  25 interested in, user interface, design, decentralized architecture...
  26
  27
  28 ## Write documentation
  29
  30 You can help to write the documentation of the REST API, code, architecture,
  31 demonstrations.
  32
  33 For the REST API you can see the documentation in [/support/doc/api](/support/doc/api) directory.
  34 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.
  35
  36 Some hints:
  37  * Routes are defined in [/server/controllers/](/server/controllers/) directory
  38  * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
  39  * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
  40
  41
  42 ## Improve the website
  43
  44 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.
  45
  46 You can help us improve it too!
  47
  48 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
  49
  50
  51 ## Develop
  52
  53 Don't hesitate to talk about features you want to develop by creating/commenting an issue
  54 before you start working on them :).
  55
  56 ### Prerequisites
  57
  58 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
  59
  60 Make sure that you have followed
  61 [the steps](/support/doc/dependencies.md)
  62 to install the dependencies.
  63
  64 Then clone the sources and install node modules:
  65
  66 ```
  67 $ git clone https://github.com/Chocobozzz/PeerTube
  68 $ cd PeerTube
  69 $ yarn install --pure-lockfile
  70 ```
  71
  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
  76 Then, create a postgres database and user with the values set in the
  77 `config/default.yaml` file. For instance, if you do not change the values
  78 there, the following commands would create a new database called `peertube_dev`
  79 and a postgres user called `peertube` with password `peertube`:
  80
  81 ```
  82 # sudo -u postgres createuser -P peertube
  83 Enter password for new role: peertube
  84 # sudo -u postgres createdb -O peertube peertube_dev
  85 ```
  86
  87 Then enable extensions PeerTube needs:
  88
  89 ```
  90 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
  91 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
  92 ```
  93
  94 In dev mode, administrator username is **root** and password is **test**.
  95
  96 ### Server side
  97
  98 You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
  99
 100 To develop on the server-side:
 101
 102 ```
 103 $ npm run dev:server
 104 ```
 105
 106 Then, the server will listen on `localhost:9000`. When server source files
 107 change, these are automatically recompiled and the server will automatically
 108 restart.
 109
 110 ### Client side
 111
 112 You can find a documentation of the server code/architecture
 113 [here](/support/doc/development/client/code.md).
 114
 115
 116 To develop on the client side:
 117
 118 ```
 119 $ npm run dev:client
 120 ```
 121
 122 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 123 Client files are automatically compiled on change, and the web browser will
 124 reload them automatically thanks to hot module replacement.
 125
 126 ### Client and server side
 127
 128 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 129 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
 130 and the web server is automatically restarted.
 131
 132 ```
 133 $ npm run dev
 134 ```
 135
 136 ### Testing the federation of PeerTube servers
 137
 138 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 139 Then, we can create the databases (if they don't already exist):
 140
 141 ```
 142 $ sudo -u postgres createuser you_username --createdb
 143 $ createdb -O peertube peertube_test{1,2,3}
 144 ```
 145
 146 Build the application and flush the old tests data:
 147
 148 ```
 149 $ npm run build
 150 $ npm run clean:server:test
 151 ```
 152
 153 This will run 3 nodes:
 154
 155 ```
 156 $ npm run play
 157 ```
 158
 159 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 160 with the `root` as username and `test{1,2,3}` for the password.
 161
 162 Instance configurations are in `config/test-{1,2,3}.yaml`.
 163
 164 ### Unit tests
 165
 166 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 167
 168 Then, we can create the databases (if they don't already exist):
 169
 170 ```
 171 $ sudo -u postgres createuser you_username --createdb --superuser
 172 $ createdb -O peertube peertube_test{1,2,3,4,5,6}
 173 ```
 174
 175 Build the application and run the unit/integration tests:
 176
 177 ```
 178 $ npm run build
 179 $ npm test
 180 ```
 181
 182 If you just want to run 1 test:
 183
 184 ```
 185 $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
 186 ```
 187
 188 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 189 Note that only instance 2 has transcoding enabled.
 190
 191 ### Troubleshooting
 192
 193 Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html).
 194
 195 ### Tutorials
 196
 197 Please check out the related section in the [development documentation](https://docs.joinpeertube.org/lang/en/devdocs/index.html#tutorials). Contribute tutorials at [framagit.org/framasoft/peertube/documentation](https://framagit.org/framasoft/peertube/documentation).