X-Git-Url: https://git.immae.eu/?a=blobdiff_plain;f=.github%2FCONTRIBUTING.md;h=4b352922eb8572ef1de3aa4a5308c51f6fd8fbdd;hb=39ba2e8e3a71961cd0087c57d25905f6a97a6b69;hp=d4488a89aefc9aac2cb3903e9be79479206e6c2c;hpb=dbe868c07080135cf62ecb8ad556d471c1e6c2ca;p=github%2FChocobozzz%2FPeerTube.git diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index d4488a89a..4b352922e 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -4,11 +4,17 @@ Interesting in contributing? Awesome! **Quick Links:** + * [Translate](#translate) * [Give your feedback](#give-your-feedback) * [Write documentation](#write-documentation) * [Develop](#develop) +## Translate + +You can help us to translate the PeerTube interface to many languages! See [the documentation](/support/doc/translation.md) to know how. + + ## Give your feedback You don't need to know how to code to start contributing to PeerTube! Other @@ -38,7 +44,9 @@ before you start working on them :). ### Prerequisites -First, make sure that you have followed +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. @@ -50,6 +58,10 @@ $ cd PeerTube $ yarn install --pure-lockfile ``` +Note that development is done on the `develop` branch. If you want to hack on +Peertube, you should switch to that branch. Also note that you have to repeat +the `yarn install --pure-lockfile` command. + 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` @@ -61,6 +73,13 @@ Enter password for new role: peertube # sudo -u postgres createdb -O peertube peertube_dev ``` +Then enable extensions PeerTube needs: + +``` +$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev +$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev +``` + In dev mode, administrator username is **root** and password is **test**. ### Server side @@ -156,4 +175,4 @@ $ npm run mocha -- --exit --require ts-node/register/type-check --bail server/te ``` Instance configurations are in `config/test-{1,2,3,4,5,6}.yaml`. -Note that only instance 2 has transcoding enabled. \ No newline at end of file +Note that only instance 2 has transcoding enabled.