Fix menu on mobile

[github/Chocobozzz/PeerTube.git] / .github / CONTRIBUTING.md

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index dec6a5cd03fd6f3c126818e13d0e0b17dcb4c462..6d095cc474ded3ae74710eed53b478a2e84d343c 100644 (file)
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -4,11 +4,17 @@ Interesting in contributing? Awesome!
 
 **Quick Links:**
 
 
 **Quick Links:**
 

+  * [Translate](#translate)

   * [Give your feedback](#give-your-feedback)
   * [Write documentation](#write-documentation)
   * [Develop](#develop)
 
 
   * [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
 ## Give your feedback
 
 You don't need to know how to code to start contributing to PeerTube! Other


@@ -20,11 +26,20 @@ interested in, user interface, design, decentralized architecture...
 ## Write documentation
 
 You can help to write the documentation of the REST API, code, architecture,
 ## Write documentation
 
 You can help to write the documentation of the REST API, code, architecture,

-demonstrations...
+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.
+
+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
+

 
 ## Develop
 
 
 ## Develop
 

-Don't hesitate to talk about features you want to develop by creating an issue
+Don't hesitate to talk about features you want to develop by creating/commenting an issue

 before you start working on them :).
 
 ### Prerequisites
 before you start working on them :).
 
 ### Prerequisites


@@ -35,23 +50,34 @@ to install the dependencies.
 
 Then clone the sources and install node modules:
 
 
 Then clone the sources and install node modules:
 

-```bash
-$ git clone -b master https://github.com/Chocobozzz/PeerTube
+```
+$ git clone https://github.com/Chocobozzz/PeerTube

 $ cd PeerTube
 $ yarn install --pure-lockfile
 ```
 
 $ 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`
 and a postgres user called `peertube` with password `peertube`:
 
 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`
 and a postgres user called `peertube` with password `peertube`:
 

-```bash
+```

 # sudo -u postgres createuser -P peertube
 Enter password for new role: peertube
 # sudo -u postgres createdb -O peertube peertube_dev
 ```
 
 # sudo -u postgres createuser -P peertube
 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
 In dev mode, administrator username is **root** and password is **test**.
 
 ### Server side


@@ -60,13 +86,13 @@ You can find a documentation of the server code/architecture [here](/support/doc
 
 To develop on the server-side:
 
 
 To develop on the server-side:
 

-```bash
+```

 $ npm run dev:server
 ```
 
 Then, the server will listen on `localhost:9000`. When server source files
 change, these are automatically recompiled and the server will automatically
 $ npm run dev:server
 ```
 
 Then, the server will listen on `localhost:9000`. When server source files
 change, these are automatically recompiled and the server will automatically

-restart. Server is in `TEST` mode so it will run requests between instances more quickly.
+restart.

 
 ### Client side
 
 
 ### Client side
 


@@ -76,7 +102,7 @@ You can find a documentation of the server code/architecture
 
 To develop on the client side:
 
 
 To develop on the client side:
 

-```bash
+```

 $ npm run dev:client
 ```
 
 $ npm run dev:client
 ```
 


@@ -84,14 +110,67 @@ The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
 Client files are automatically compiled on change, and the web browser will
 reload them automatically thanks to hot module replacement.
 
 Client files are automatically compiled on change, and the web browser will
 reload them automatically thanks to hot module replacement.
 

-### Test federation
+### Client and server side

 
 

-This will run 3 nodes:
+The API will listen on `localhost:9000` and the frontend on `localhost:3000`.
+File changes are automatically recompiled, injected in the web browser (no need to refresh manually)
+and the web server is automatically restarted.
+
+```
+$ npm run dev
+```
+
+### Federation
+
+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):
+
+```
+$ sudo -u postgres createuser you_username --createdb
+$ createdb -O peertube peertube_test{1,2,3}
+```
+
+Build the application and flush the old tests data:

 
 

-```bash
+```
+$ npm run build

 $ npm run clean:server:test
 $ npm run clean:server:test

+```
+
+This will run 3 nodes:
+
+```

 $ npm run play
 ```
 
 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 with the `root` as username and `test{1,2,3}` for the password.
 $ npm run play
 ```
 
 Then you will get access to the three nodes at `http://localhost:900{1,2,3}`
 with the `root` as username and `test{1,2,3}` for the password.

+
+Instance configurations are in `config/test-{1,2,3}.yaml`.
+
+### Unit tests
+
+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):
+
+```
+$ sudo -u postgres createuser you_username --createdb --superuser
+$ createdb -O peertube peertube_test{1,2,3,4,5,6}
+```
+
+Build the application and run the unit/integration tests:
+
+```
+$ npm run build
+$ 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
+```
+
+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