* [Translate](#translate)
* [Give your feedback](#give-your-feedback)
* [Write documentation](#write-documentation)
- * [Develop](#develop)
* [Improve the website](#improve-the-website)
+ * [Develop](#develop)
+ * [Write a plugin or a theme](#plugins--themes)
## Translate
Make sure that you have followed
[the steps](/support/doc/dependencies.md)
-to install the dependencies.
+to install the dependencies. You'll need to install **NodeJS 10**.
-Then clone the sources and install node modules:
+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
```
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`
### Client side
-You can find a documentation of the server code/architecture
+You can find a documentation of the client code/architecture
[here](https://docs.joinpeertube.org/#/contribute-architecture?id=client-code).
```
$ sudo -u postgres createuser you_username --createdb --superuser
-$ createdb -O peertube peertube_test{1,2,3,4,5,6}
+$ npm run clean:server:test
```
Build the application and run the unit/integration tests:
```
-$ npm run build
+$ 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
+$ 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