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