forks
/
peertube
1
0
Fork 0
Code Releases Activity

Improve contributing guide

This commit is contained in:
Chocobozzz 2018-04-03 08:44:04 +02:00
parent 2f7ac61807
commit 1909685158
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 23 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
.github/CONTRIBUTING.md vendored
View File

@ -75,7 +75,7 @@ $ npm run dev:server
Then, the server will listen on `localhost:9000`. When server source files Then, the server will listen on `localhost:9000`. When server source files
change, these are automatically recompiled and the server will automatically 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
@ -93,14 +93,35 @@ 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 Client files are automatically compiled on change, and the web browser will
reload them automatically thanks to hot module replacement. reload them automatically thanks to hot module replacement.
### Test federation ### Client and server side
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
This will run 3 nodes: This will run 3 nodes:
``` ```
$ npm run build
$ npm run clean:server:test $ npm run clean:server:test
$ npm run play $ npm run play
``` ```
Then you will get access to the three nodes at `http://localhost:900{1,2,3}` 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. with the `root` as username and `test{1,2,3}` for the password.
### Unit tests
To run unit tests, you need to build the application first:
```
$ npm run build
$ npm test
```