<!-- 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)
- [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)
+ - [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)
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
```
### 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
-
-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
+### RTL layout
-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):
+To test RTL layout using `ar` locale:
```
-$ sudo -u postgres createuser you_username --createdb --superuser
-$ npm run clean:server:test
+$ npm run dev -- --ar-locale
```
-Build the application and run the unit/integration tests:
-
-```
-$ npm run build -- --light
-$ npm test
-```
+### Testing
-If you just want to run 1 test (which is what you want to debug a specific test rapidly):
+#### Unit/integration tests
-```
-$ TS_NODE_FILES=true npm run mocha -- --exit -r ts-node/register -r tsconfig-paths/register --bail server/tests/api/videos/single-server.ts
-```
+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.
-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](/support/doc/development/tests.md) to run tests locally.
#### Testing the federation of PeerTube servers
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}`
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`
+ * Run PeerTube using mailslurper SMTP port: `NODE_CONFIG='{ "smtp": { "hostname": "localhost", "port": 2500, "tls": false } }' NODE_ENV=dev node dist/server`
+
+### Environment variables
+
+PeerTube can be configured using environment variables.
+See the list on https://docs.joinpeertube.org/maintain-configuration?id=environment-variables
+
+Additionally to these ones, we provide some environment for dev/test purpose:
+
+ * `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