Interested in contributing? Awesome!
-**Quick Links:**
+**This guide will present you the following contribution topics:**
- * [Translate](#translate)
- * [Give your feedback](#give-your-feedback)
- * [Write documentation](#write-documentation)
- * [Develop](#develop)
+<!-- 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 -->
+
## Translate
You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how.
You can help to write the documentation of the REST API, code, architecture,
demonstrations.
-For the REST API you can see the documentation in [/support/doc/api](/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.
+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. 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.
Some hints:
- * Routes are defined in [/server/controllers/](/server/controllers/) directory
- * Parameters validators are defined in [/server/middlewares/validators](/server/middlewares/validators) directory
- * Models sent/received by the controllers are defined in [/shared/models](/shared/models) directory
+ * 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
+
+
+## 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
## Develop
-Don't hesitate to talk about features you want to develop by creating/commenting an issue
-before you start working on them :).
+Always talk about features you want to develop by creating/finding and commenting the issue tackling your problem
+before you start working on it, and inform the community that you begin coding by claiming the issue.
+
+Once you are ready to show your code to ask for feedback, submit a *draft* Pull Request.
+Once you are ready for a code review before merge, submit a Pull Request. In any case, please
+link your PR to the issues it solves by using the GitHub syntax: "fixes #issue_number".
### Prerequisites
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)
+1) Make sure that you have followed
+[the steps](/support/doc/dependencies.md)
to install the dependencies.
-
-Then clone the sources and install node modules:
-
+1) Install [parallel](https://www.gnu.org/software/parallel/) to be able to run tests.
+1) Fork the Github repository.
+1) Run the following commands.
```
$ git clone https://github.com/Chocobozzz/PeerTube
$ cd PeerTube
+$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
$ yarn install --pure-lockfile
```
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`
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](/support/doc/development/server/code.md).
+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:
### Client side
-You can find a documentation of the server code/architecture
-[here](/support/doc/development/client/code.md).
+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:
$ npm run dev
```
-Depending on your OS, you may face the following error :
+### Testing
+
+Your code contributions must pass the tests before they can be merged. Tests ensure most of the application behaves
+as expected and respect the syntax conventions. They will run upon PR submission as part of our CI, but running them beforehand yourself will get you faster feedback and save CI runner time for others.
+
+PeerTube mainly features backend and plugin tests, found in `server/tests`.
+
+#### 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):
+
```
-$ [nodemon] Internal watch failed: ENOSPC: no space left on device, watch '/PeerTube/dist'
+$ sudo -u postgres createuser you_username --createdb --superuser
+$ npm run clean:server:test
```
-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 :
+Build the application and run the unit/integration tests:
+
```
-echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p
+$ npm run build -- --light
+$ npm test
```
-See more information here : https://github.com/guard/listen/wiki/Increasing-the-amount-of-inotify-watchers
+If you just want to run 1 test (which is what you want to debug a specific test rapidly):
-### Configurations for VPS
+```
+$ TS_NODE_FILES=true npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/videos/single-server.ts
+```
-If you want to develop using a Virtual Private Server, you will need to configure the url for the API and the hostname. First, you need to edit the [client/src/environments/environment.hmr.ts](client/src/environments/environment.hmr.ts) file by replacing the `localhost` in the `apiUrl` field with the address of your VPS. Thus, the [Hot Module Replacement](https://webpack.js.org/concepts/hot-module-replacement/) from Webpack will be set up for developping with live-reload.
+While testing, you might want to display a server's logs:
-Next, you will need to edit the [config/default.yaml](config/default.yaml) file. Just replace the `localhost` with your VPS address in the following `hostname` fields :
```
-listen:
- hostname: 'my-vps-address.net'
- port: 9000
-
-webserver:
- https: false
- hostname: 'my-vps-address.net'
- port: 9000
+NODE_APP_INSTANCE=1 NODE_ENV=test npm run parse-log -- --level debug | less +GF
```
-Then, you just need to listen to `https://my-vps-address.net:3000/` in your web browser.
+Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
+Note that only instance 2 has transcoding enabled.
-### Federation
+#### 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):
Build the application and flush the old tests data:
```
-$ npm run build
+$ npm run build -- --light
$ npm run clean:server:test
```
Instance configurations are in `config/test-{1,2,3}.yaml`.
-### Unit tests
+### Emails
-Create a PostgreSQL user **with the same name as your username** in order to avoid using the *postgres* user.
+To test emails with PeerTube:
-Then, we can create the databases (if they don't already exist):
+ * 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`
-```
-$ sudo -u postgres createuser you_username --createdb --superuser
-$ createdb -O peertube peertube_test{1,2,3,4,5,6}
-```
+## Plugins & Themes
-Build the application and run the unit/integration tests:
-
-```
-$ npm run build
-$ npm test
-```
-
-If you just want to run 1 test:
-
-```
-$ npm run mocha -- --exit --require ts-node/register/type-check --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.
+See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins
projects / github / Chocobozzz / PeerTube.git / blobdiff