.github/CONTRIBUTING.md

   1 # Welcome to the contributing guide for PeerTube
   2
   3 Interesting 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
  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 ## Develop
  41
  42 Don't hesitate to talk about features you want to develop by creating/commenting an issue
  43 before you start working on them :).
  44
  45 ### Prerequisites
  46
  47 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
  48
  49 Make sure that you have followed
  50 [the steps](/support/doc/dependencies.md)
  51 to install the dependencies.
  52
  53 Then clone the sources and install node modules:
  54
  55 ```
  56 $ git clone https://github.com/Chocobozzz/PeerTube
  57 $ cd PeerTube
  58 $ yarn install --pure-lockfile
  59 ```
  60
  61 Note that development is done on the `develop` branch. If you want to hack on
  62 Peertube, you should switch to that branch. Also note that you have to repeat
  63 the `yarn install --pure-lockfile` command.
  64
  65 Then, create a postgres database and user with the values set in the
  66 `config/default.yaml` file. For instance, if you do not change the values
  67 there, the following commands would create a new database called `peertube_dev`
  68 and a postgres user called `peertube` with password `peertube`:
  69
  70 ```
  71 # sudo -u postgres createuser -P peertube
  72 Enter password for new role: peertube
  73 # sudo -u postgres createdb -O peertube peertube_dev
  74 ```
  75
  76 Then enable extensions PeerTube needs:
  77
  78 ```
  79 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
  80 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
  81 ```
  82
  83 In dev mode, administrator username is **root** and password is **test**.
  84
  85 ### Server side
  86
  87 You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
  88
  89 To develop on the server-side:
  90
  91 ```
  92 $ npm run dev:server
  93 ```
  94
  95 Then, the server will listen on `localhost:9000`. When server source files
  96 change, these are automatically recompiled and the server will automatically
  97 restart.
  98
  99 ### Client side
 100
 101 You can find a documentation of the server code/architecture
 102 [here](/support/doc/development/client/code.md).
 103
 104
 105 To develop on the client side:
 106
 107 ```
 108 $ npm run dev:client
 109 ```
 110
 111 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 112 Client files are automatically compiled on change, and the web browser will
 113 reload them automatically thanks to hot module replacement.
 114
 115 ### Client and server side
 116
 117 The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 118 File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
 119 and the web server is automatically restarted.
 120
 121 ```
 122 $ npm run dev
 123 ```
 124
 125 ### Federation
 126
 127 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 128 Then, we can create the databases (if they don't already exist):
 129
 130 ```
 131 $ sudo -u postgres createuser you_username --createdb
 132 $ createdb -O peertube peertube_test{1,2,3}
 133 ```
 134
 135 Build the application and flush the old tests data:
 136
 137 ```
 138 $ npm run build
 139 $ npm run clean:server:test
 140 ```
 141
 142 This will run 3 nodes:
 143
 144 ```
 145 $ npm run play
 146 ```
 147
 148 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 149 with the `root` as username and `test{1,2,3}` for the password.
 150
 151 Instance configurations are in `config/test-{1,2,3}.yaml`.
 152
 153 ### Unit tests
 154
 155 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
 156
 157 Then, we can create the databases (if they don't already exist):
 158
 159 ```
 160 $ sudo -u postgres createuser you_username --createdb --superuser
 161 $ createdb -O peertube peertube_test{1,2,3,4,5,6}
 162 ```
 163
 164 Build the application and run the unit/integration tests:
 165
 166 ```
 167 $ npm run build
 168 $ npm test
 169 ```
 170
 171 If you just want to run 1 test:
 172
 173 ```
 174 $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
 175 ```
 176
 177 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
 178 Note that only instance 2 has transcoding enabled.