**This guide will present you the following contribution topics:**
- * [Translate](#translate)
- * [Give your feedback](#give-your-feedback)
- * [Write documentation](#write-documentation)
- * [Improve the website](#improve-the-website)
- * [Develop](#develop)
- * [Write a plugin or a theme](#plugins--themes)
+<!-- 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)
+ - [RTL layout](#rtl-layout)
+ - [Testing](#testing)
+ - [Unit/integration tests](#unitintegration-tests)
+ - [Testing the federation of PeerTube servers](#testing-the-federation-of-peertube-servers)
+ - [Emails](#emails)
+- [Plugins & Themes](#plugins--themes)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
## Translate
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
## 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
+1) 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:
-
+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
-$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
$ cd PeerTube
+$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
$ yarn install --pure-lockfile
```
$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
```
+Peertube also requires a running redis server, no special setup is needed for
+this.
+
In dev mode, administrator username is **root** and password is **test**.
### Online development
### Server side
-You can find a documentation of the server code/architecture [here](https://docs.joinpeertube.org/#/contribute-architecture?id=server-code).
+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 client code/architecture
-[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
+[here](https://docs.joinpeertube.org/contribute-architecture?id=client-code).
To develop on the client side:
$ npm run dev
```
-### Testing the federation of PeerTube servers
+### RTL layout
+
+To test RTL layout using `ar` locale:
+
+```
+$ npm run dev -- --ar-locale
+```
+
+### Testing
+
+#### Unit/integration tests
+
+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.
+
+See the [dedicated documentation](/support/doc/development/tests.md) to run tests locally.
+
+#### 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 -- --light
+$ npm run build
$ npm run clean:server:test
```
-This will run 3 nodes:
+To run 3 nodes:
```
-$ npm run play
+$ NODE_APP_INSTANCE=1 NODE_ENV=test npm start
+$ NODE_APP_INSTANCE=2 NODE_ENV=test npm start
+$ NODE_APP_INSTANCE=3 NODE_ENV=test npm start
```
Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
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=dev node dist/server`
-```
-$ sudo -u postgres createuser you_username --createdb --superuser
-$ npm run clean:server:test
-```
+### Environment variables
-Build the application and run the unit/integration tests:
+PeerTube can be configured using environment variables.
+See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables
-```
-$ npm run build -- --light
-$ 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
-```
+Additionally to these ones, we provide some environment for dev/test purpose:
-Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
-Note that only instance 2 has transcoding enabled.
+ * `PRODUCTION_CONSTANTS=true`: in `NODE_ENV=dev` or `NODE_ENV=test` PeerTube customizes some constants. To prevent this behaviour, you can set `PRODUCTION_CONSTANTS` env to
+ `true`
+ * `PEERTUBE_LOCAL_CONFIG`: directory to find the local configuration file (used by web admin)
+ * `NODE_DB_LOG=false`: disable SQL request logging
## Plugins & Themes
-See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins
+See the dedicated documentation: https://docs.joinpeertube.org/contribute-plugins
projects / github / Chocobozzz / PeerTube.git / blobdiff