PeerTube/.github/CONTRIBUTING.md

228 lines
7.5 KiB
Markdown
Raw Normal View History

2016-07-22 11:45:29 +02:00
# Welcome to the contributing guide for PeerTube
2018-10-24 23:39:52 +02:00
Interested in contributing? Awesome!
2016-07-22 11:45:29 +02:00
**This guide will present you the following contribution topics:**
2016-07-22 11:45:29 +02:00
2020-07-10 09:39:53 +02:00
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [Translate](#translate)
- [Give your feedback](#give-your-feedback)
- [Write documentation](#write-documentation)
- [Improve the website](#improve-the-website)
- [Develop](#develop)
- [Prerequisites](#prerequisites)
- [Online development](#online-development)
- [Server side](#server-side)
- [Client side](#client-side)
- [Client and server side](#client-and-server-side)
- [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
- [Unit tests](#unit-tests)
- [Emails](#emails)
- [Plugins & Themes](#plugins--themes)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2016-07-22 11:45:29 +02:00
2018-06-21 14:07:53 +02:00
## Translate
You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
2016-07-22 11:45:29 +02:00
## 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
2018-01-12 18:07:41 +01:00
interested in, user interface, design, decentralized architecture...
2016-07-22 11:45:29 +02:00
2018-01-12 18:07:41 +01:00
## Write documentation
2016-07-22 11:45:29 +02:00
2018-01-12 18:07:41 +01:00
You can help to write the documentation of the REST API, code, architecture,
2018-01-24 12:02:38 +01:00
demonstrations.
2020-05-13 11:24:56 +02:00
For the REST API you can see the documentation in [/support/doc/api](https://github.com/Chocobozzz/PeerTube/tree/develop/support/doc/api) directory.
2020-07-10 09:39:53 +02:00
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. You can also use [redoc-cli](https://github.com/Redocly/redoc/blob/master/cli/README.md) and run `redoc-cli serve --watch support/doc/api/openapi.yaml` to see the final result.
2018-01-24 12:02:38 +01:00
Some hints:
2020-05-13 11:24:56 +02:00
* 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
2018-01-24 12:02:38 +01:00
2016-07-22 11:45:29 +02:00
## Improve the website
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.
You can help us improve it too!
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
2018-01-12 18:07:41 +01:00
## Develop
2016-07-22 11:45:29 +02:00
2018-02-08 17:31:05 +01:00
Don't hesitate to talk about features you want to develop by creating/commenting an issue
before you start working on them :).
2016-07-22 11:45:29 +02:00
2018-01-12 18:07:41 +01:00
### Prerequisites
2016-07-22 11:45:29 +02:00
First, you should use a server or PC with at least 4GB of RAM. Less RAM may lead to crashes.
2019-01-30 09:39:42 +01:00
Make sure that you have followed
[the steps](/support/doc/dependencies.md)
2020-05-13 11:31:42 +02:00
to install the dependencies.
Fork the github repository,
and then clone the sources and install node modules:
2018-01-12 18:55:45 +01:00
```
$ git clone https://github.com/Chocobozzz/PeerTube
$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
2018-01-12 18:07:41 +01:00
$ 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`:
2018-01-12 18:55:45 +01:00
```
2018-01-12 18:07:41 +01:00
# 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
```
2018-01-12 18:07:41 +01:00
In dev mode, administrator username is **root** and password is **test**.
2019-01-30 09:39:42 +01:00
### Online development
You can get a complete PeerTube development setup with Gitpod, a free one-click online IDE for GitHub:
[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](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).
2018-01-12 18:07:41 +01:00
To develop on the server-side:
2018-01-12 18:55:45 +01:00
```
2018-01-12 18:07:41 +01:00
$ npm run dev:server
```
Then, the server will listen on `localhost:9000`. When server source files
change, these are automatically recompiled and the server will automatically
2018-04-03 08:44:04 +02:00
restart.
### Client side
You can find a documentation of the client code/architecture
[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
2018-01-12 18:07:41 +01:00
To develop on the client side:
2018-01-12 18:55:45 +01:00
```
2018-01-12 18:07:41 +01:00
$ 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.
2016-07-22 11:45:29 +02:00
2018-04-03 08:44:04 +02:00
### 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.
```
$ npm run dev
```
### Testing the federation of PeerTube servers
2016-12-01 22:16:38 +01:00
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:
2016-07-22 11:45:29 +02:00
2018-01-12 18:55:45 +01:00
```
2019-04-04 16:37:18 +02:00
$ npm run build -- --light
2018-01-12 18:07:41 +01:00
$ npm run clean:server:test
```
This will run 3 nodes:
```
2018-01-12 18:07:41 +01:00
$ npm run play
```
2016-07-22 11:45:29 +02:00
2018-01-12 18:07:41 +01:00
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.
2018-04-03 08:44:04 +02:00
Instance configurations are in `config/test-{1,2,3}.yaml`.
2018-04-03 08:44:04 +02:00
### Unit tests
Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
2018-06-07 16:50:33 +02:00
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:
2018-04-03 08:44:04 +02:00
```
$ npm run build -- --light
2018-04-03 08:44:04 +02:00
$ npm test
```
2018-04-19 16:23:09 +02:00
If you just want to run 1 test:
```
2020-02-12 10:36:37 +01:00
$ npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/index.ts
2018-04-19 16:23:09 +02:00
```
Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
Note that only instance 2 has transcoding enabled.
2019-07-24 11:55:08 +02:00
2020-07-10 09:39:53 +02:00
### Emails
To test emails with PeerTube:
* Run [mailslurper](http://mailslurper.com/)
* Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=test npm start`
2019-07-24 11:55:08 +02:00
## Plugins & Themes
See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins