* [Translate](#translate)
* [Give your feedback](#give-your-feedback)
* [Write documentation](#write-documentation)
- * [Develop](#develop)
* [Improve the website](#improve-the-website)
- * [Troubleshooting](#troubleshooting)
- * [Tutorials](#tutorials)
+ * [Develop](#develop)
+ * [Write a plugin or a theme](#plugins--themes)
## Translate
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)
-to install the dependencies.
+Make sure that you have followed
+[the steps](/support/doc/dependencies.md)
+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`
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:
+
+[![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](/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:
Build the application and flush the old tests data:
```
-$ npm run build
+$ npm run build -- --light
$ npm run clean:server:test
```
```
$ 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
```
Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`.
Note that only instance 2 has transcoding enabled.
-### Troubleshooting
-
-Please check out the issues and [list of common errors](https://docs.joinpeertube.org/lang/en/devdocs/troubleshooting.html).
-
-### Tutorials
+## Plugins & Themes
-Please check out the related section in the [development documentation](https://docs.joinpeertube.org/lang/en/devdocs/index.html#tutorials). Contribute tutorials at [framagit.org/framasoft/peertube/documentation](https://framagit.org/framasoft/peertube/documentation).
+See the dedicated documentation: https://docs.joinpeertube.org/#/contribute-plugins