.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 Fork the github repository,
  63 and then clone the sources and install node modules:
  64
  65 ```
  66 $ git clone https://github.com/YOUR_GITHUB_USERNAME/PeerTube
  67 $ cd PeerTube
  68 $ yarn install --pure-lockfile
  69 ```
  70
  71 Note that development is done on the `develop` branch. If you want to hack on
  72 Peertube, you should switch to that branch. Also note that you have to repeat
  73 the `yarn install --pure-lockfile` command.
  74
  75 Then, create a postgres database and user with the values set in the
  76 `config/default.yaml` file. For instance, if you do not change the values
  77 there, the following commands would create a new database called `peertube_dev`
  78 and a postgres user called `peertube` with password `peertube`:
  79
  80 ```
  81 # sudo -u postgres createuser -P peertube
  82 Enter password for new role: peertube
  83 # sudo -u postgres createdb -O peertube peertube_dev
  84 ```
  85
  86 Then enable extensions PeerTube needs:
  87
  88 ```
  89 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
  90 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
  91 ```
  92
  93 In dev mode, administrator username is **root** and password is **test**.
  94
  95 ### Online development
  96
  97 You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
  98
  99 [![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
 100
 101 ### Server side
 102
 103 You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
 104
 105 To develop on the server-side:
 106
 107 ```
 108 $ npm run dev:server
 109 ```
 110
 111 Then, the server will listen on `localhost:9000`. When server source files
 112 change, these are automatically recompiled and the server will automatically
 113 restart.
 114
 115 ### Client side
 116
 117 You can find a documentation of the server code/architecture
 118 [here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
 119
 120
 121 To develop on the client side:
 122
 123 ```
 124 $ npm run dev:client
 125 ```
 126
 127 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 128 Client files are automatically compiled on change, and the web browser will
 129 reload them automatically thanks to hot module replacement.
 130
 131 ### Client and server side
 132
 133 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 134 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
 135 and the web server is automatically restarted.
 136
 137 ```
 138 $ npm run dev
 139 ```
 140
 141 ### Testing the federation of PeerTube servers
 142
 143 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 144 Then, we can create the databases (if they don't already exist):
 145
 146 ```
 147 $ sudo -u postgres createuser you_username --createdb
 148 $ createdb -O peertube peertube_test{1,2,3}
 149 ```
 150
 151 Build the application and flush the old tests data:
 152
 153 ```
 154 $ npm run build -- --light
 155 $ npm run clean:server:test
 156 ```
 157
 158 This will run 3 nodes:
 159
 160 ```
 161 $ npm run play
 162 ```
 163
 164 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 165 with the `root` as username and `test{1,2,3}` for the password.
 166
 167 Instance configurations are in `config/test-{1,2,3}.yaml`.
 168
 169 ### Unit tests
 170
 171 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 172
 173 Then, we can create the databases (if they don't already exist):
 174
 175 ```
 176 $ sudo -u postgres createuser you_username --createdb --superuser
 177 $ createdb -O peertube peertube_test{1,2,3,4,5,6}
 178 ```
 179
 180 Build the application and run the unit/integration tests:
 181
 182 ```
 183 $ npm run build
 184 $ npm test
 185 ```
 186
 187 If you just want to run 1 test:
 188
 189 ```
 190 $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
 191 ```
 192
 193 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 194 Note that only instance 2 has transcoding enabled.