1 # Welcome to the contributing guide for PeerTube
3 Interesting in contributing? Awesome!
7 * [Translate](#translate)
8 * [Give your feedback](#give-your-feedback)
9 * [Write documentation](#write-documentation)
15 You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
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...
26 ## Write documentation
28 You can help to write the documentation of the REST API, code, architecture,
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.
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
42 Don't hesitate to talk about features you want to develop by creating/commenting an issue
43 before you start working on them :).
47 First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
49 Make sure that you have followed
50 [the steps](/support/doc/dependencies.md)
51 to install the dependencies.
53 Then clone the sources and install node modules:
56 $ git clone https://github.com/Chocobozzz/PeerTube
58 $ yarn install --pure-lockfile
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.
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`:
71 # sudo -u postgres createuser -P peertube
72 Enter password for new role: peertube
73 # sudo -u postgres createdb -O peertube peertube_dev
76 Then enable extensions PeerTube needs:
79 $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
80 $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
83 In dev mode, administrator username is **root** and password is **test**.
87 You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
89 To develop on the server-side:
95 Then, the server will listen on `localhost:9000`. When server source files
96 change, these are automatically recompiled and the server will automatically
101 You can find a documentation of the server code/architecture
102 [here](/support/doc/development/client/code.md).
105 To develop on the client side:
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.
115 ### Client and server side
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.
125 Depending on your OS, you may face the following error :
127 $ [nodemon] Internal watch failed: ENOSPC: no space left on device, watch '/PeerTube/dist'
130 This is due to your system's limit on the number of files you can monitor for live-checking changes. For example, Ubuntu uses inotify and this limit is set to 8192. Then you need to change this limit :
132 echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
135 See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
139 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
140 Then, we can create the databases (if they don't already exist):
143 $ sudo -u postgres createuser you_username --createdb
144 $ createdb -O peertube peertube_test{1,2,3}
147 Build the application and flush the old tests data:
151 $ npm run clean:server:test
154 This will run 3 nodes:
160 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
161 with the `root` as username and `test{1,2,3}` for the password.
163 Instance configurations are in `config/test-{1,2,3}.yaml`.
167 Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
169 Then, we can create the databases (if they don't already exist):
172 $ sudo -u postgres createuser you_username --createdb --superuser
173 $ createdb -O peertube peertube_test{1,2,3,4,5,6}
176 Build the application and run the unit/integration tests:
183 If you just want to run 1 test:
186 $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/tests/api/index.ts
189 Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
190 Note that only instance 2 has transcoding enabled.