# Welcome to the contributing guide for PeerTube
-Interesting in contributing? Awesome :)
+Interested in contributing? Awesome!
-**Quick Links:**
+**This guide will present you the following contribution topics:**
+ * [Translate](#translate)
* [Give your feedback](#give-your-feedback)
- * [Develop on the Server side](#develop-on-the-server-side)
- * [Develop on the Client side](#develop-on-the-client-side)
- * [Get started with development](#get-started-with-development)
* [Write documentation](#write-documentation)
+ * [Improve the website](#improve-the-website)
+ * [Develop](#develop)
+ * [Write a plugin or a theme](#plugins--themes)
+
+## Translate
+
+You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
## Give your feedback
You don't need to know how to code to start contributing to PeerTube! Other
contributions are very valuable too, among which: you can test the software and
report bugs, you can give feedback on potential bugs, features that you are
-interested in, user interace, design, decentralized architecture...
+interested in, user interface, design, decentralized architecture...
-## Development
+## Write documentation
-## Develop on the Server side
+You can help to write the documentation of the REST API, code, architecture,
+demonstrations.
-The server is a web server developed with
-[NodeJS](https://nodejs.org)/[Express](http://expressjs.com).
+For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
+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.
-Newcomer? You can find a documentation of the server code/architecture
-[here](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/server/code.md).
+Some hints:
+ * Routes are defined in [/server/controllers/](https://github.com/Chocobozzz/PeerTube/tree/develop/server/controllers) directory
+ * Parameters validators are defined in [/server/middlewares/validators](https://github.com/Chocobozzz/PeerTube/tree/develop/server/middlewares/validators) directory
+ * Models sent/received by the controllers are defined in [/shared/models](https://github.com/Chocobozzz/PeerTube/tree/develop/shared/models) directory
-Don't hesitate to talk about features you want to develop by creating an issue
-before you start working on them :).
+## Improve the website
-## Develop on the Client side
+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.
-The client is a web application developed with
-[TypeScript](https://www.typescriptlang.org/)/[Angular2](https://angular.io/).
+You can help us improve it too!
-Newcomer? You can find a documentation of the server code/architecture
-[here](https://github.com/Chocobozzz/PeerTube/blob/master/support/doc/client/code.md).
+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
-## Get started with development
+## Develop
-In this mode, the server will run requests between instances more quickly, the
-video durations are limited to a few seconds.
+Don't hesitate to talk about features you want to develop by creating/commenting an issue
+before you start working on them :).
### Prerequisites
-First, make sure that you have followed the steps to install the dependencies.
+First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
+
+Make sure that you have followed
+[the steps](/support/doc/dependencies.md)
+to install the dependencies.
+
+Fork the github repository,
+and then clone the sources and install node modules:
+
+```
+$ git clone https://github.com/Chocobozzz/PeerTube
+$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
+$ cd PeerTube
+$ yarn install --pure-lockfile
+```
+
+Note that development is done on the `develop` branch. If you want to hack on
+Peertube, you should switch to that branch. Also note that you have to repeat
+the `yarn install --pure-lockfile` command.
+
+When you create a new branch you should also tell to use your repo for upload
+not default one. To do just do:
+```
+$ git push --set-upstream me <your branch name>
+```
Then, create a postgres database and user with the values set in the
`config/default.yaml` file. For instance, if you do not change the values
there, the following commands would create a new database called `peertube_dev`
and a postgres user called `peertube` with password `peertube`:
-```bash
- # sudo -u postgres createuser -P peertube
- Enter password for new role: peertube
- # sudo -u postgres createdb -O peertube peertube_dev
```
+# sudo -u postgres createuser -P peertube
+Enter password for new role: peertube
+# sudo -u postgres createdb -O peertube peertube_dev
+```
+
+Then enable extensions PeerTube needs:
+
+```
+$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
+$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
+```
+
+In dev mode, administrator username is **root** and password is **test**.
+
+### Online development
+
+You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
+
+[](https://gitpod.io/#https://github.com/Chocobozzz/PeerTube)
### Server side
+You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
+
To develop on the server-side:
-```bash
- $ npm run dev:server
+```
+$ npm run dev:server
```
Then, the server will listen on `localhost:9000`. When server source files
### Client side
+You can find a documentation of the client code/architecture
+[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
+
+
To develop on the client side:
-```bash
- $ npm run dev:client
+```
+$ npm run dev:client
```
The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
Client files are automatically compiled on change, and the web browser will
reload them automatically thanks to hot module replacement.
-**Username**: *root* <br/>
-**Password**: *test*
+### Client and server side
+The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
+File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
+and the web server is automatically restarted.
-## Write documentation
+```
+$ npm run dev
+```
-You can help to write the documentation of the REST API, code, architecture,
-demonstrations...
+### Testing the federation of PeerTube servers
+
+Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
+Then, we can create the databases (if they don't already exist):
+
+```
+$ sudo -u postgres createuser you_username --createdb
+$ createdb -O peertube peertube_test{1,2,3}
+```
+
+Build the application and flush the old tests data:
+
+```
+$ npm run build -- --light
+$ npm run clean:server:test
+```
+
+This will run 3 nodes:
+
+```
+$ npm run play
+```
+
+Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
+with the `root` as username and `test{1,2,3}` for the password.
+
+Instance configurations are in `config/test-{1,2,3}.yaml`.
+
+### Unit tests
+
+Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
+
+Then, we can create the databases (if they don't already exist):
+
+```
+$ sudo -u postgres createuser you_username --createdb --superuser
+$ npm run clean:server:test
+```
+
+Build the application and run the unit/integration tests:
+
+```
+$ npm run build -- --light
+$ npm test
+```
+
+If you just want to run 1 test:
+
+```
+$ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts
+```
+
+Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
+Note that only instance 2 has transcoding enabled.
+
+## Plugins & Themes
+
+See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins
projects / oweals / peertube.git / blobdiff