1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
|
# Welcome to the contributing guide for PeerTube
Interesting in contributing? Awesome!
**Quick Links:**
* [Give your feedback](#give-your-feedback)
* [Write documentation](#write-documentation)
* [Develop](#develop)
## Give your feedback
You don't need to know how to code to start contributing to PeerTube! Other
contributions are very valuable too, among which: you can test the software and
report bugs, you can give feedback on potential bugs, features that you are
interested in, user interface, design, decentralized architecture...
## Write documentation
You can help to write the documentation of the REST API, code, architecture,
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
Don't hesitate to talk about features you want to develop by creating an issue
before you start working on them :).
### Prerequisites
First, make sure that you have followed
[the steps](/support/doc/dependencies.md)
to install the dependencies.
Then clone the sources and install node modules:
```
$ git clone -b master https://github.com/Chocobozzz/PeerTube
$ cd PeerTube
$ yarn install --pure-lockfile
```
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`:
```
# sudo -u postgres createuser -P peertube
Enter password for new role: peertube
# sudo -u postgres createdb -O peertube peertube_dev
```
In dev mode, administrator username is **root** and password is **test**.
### Server side
You can find a documentation of the server code/architecture [here](/support/doc/development/server/code.md).
To develop on the server-side:
```
$ 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.
### Client side
You can find a documentation of the server code/architecture
[here](/support/doc/development/client/code.md).
To develop on the client side:
```
$ npm run dev:client
```
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.
### Test federation
This will run 3 nodes:
```
$ npm run clean:server:test
$ 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.
|
