diff options
author | Chocobozzz <me@florianbigard.com> | 2018-04-03 08:44:04 +0200 |
---|---|---|
committer | Chocobozzz <me@florianbigard.com> | 2018-04-03 08:44:04 +0200 |
commit | 1909685158e092df617e50add9e6e655b5d23cbf (patch) | |
tree | 6757d4e0d2614750ff3a65785e0bf8242b09dba2 /.github | |
parent | 2f7ac61807144d35dcc5a822b4b42c7a0c58644c (diff) | |
download | PeerTube-1909685158e092df617e50add9e6e655b5d23cbf.tar.gz PeerTube-1909685158e092df617e50add9e6e655b5d23cbf.tar.zst PeerTube-1909685158e092df617e50add9e6e655b5d23cbf.zip |
Improve contributing guide
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 25 |
1 files changed, 23 insertions, 2 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index c9988bfea..a58efc1dd 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -75,7 +75,7 @@ $ npm run dev:server | |||
75 | 75 | ||
76 | Then, the server will listen on `localhost:9000`. When server source files | 76 | Then, the server will listen on `localhost:9000`. When server source files |
77 | change, these are automatically recompiled and the server will automatically | 77 | change, these are automatically recompiled and the server will automatically |
78 | restart. Server is in `TEST` mode so it will run requests between instances more quickly. | 78 | restart. |
79 | 79 | ||
80 | ### Client side | 80 | ### Client side |
81 | 81 | ||
@@ -93,14 +93,35 @@ The API will listen on `localhost:9000` and the frontend on `localhost:3000`. | |||
93 | Client files are automatically compiled on change, and the web browser will | 93 | Client files are automatically compiled on change, and the web browser will |
94 | reload them automatically thanks to hot module replacement. | 94 | reload them automatically thanks to hot module replacement. |
95 | 95 | ||
96 | ### Test federation | 96 | ### Client and server side |
97 | |||
98 | The API will listen on `localhost:9000` and the frontend on `localhost:3000`. | ||
99 | File changes are automatically recompiled, injected in the web browser (no need to refresh manually) | ||
100 | and the web server is automatically restarted. | ||
101 | |||
102 | ``` | ||
103 | $ npm run dev | ||
104 | ``` | ||
105 | |||
106 | ### Federation | ||
97 | 107 | ||
98 | This will run 3 nodes: | 108 | This will run 3 nodes: |
99 | 109 | ||
100 | ``` | 110 | ``` |
111 | $ npm run build | ||
101 | $ npm run clean:server:test | 112 | $ npm run clean:server:test |
102 | $ npm run play | 113 | $ npm run play |
103 | ``` | 114 | ``` |
104 | 115 | ||
105 | Then you will get access to the three nodes at `http://localhost:900{1,2,3}` | 116 | Then you will get access to the three nodes at `http://localhost:900{1,2,3}` |
106 | with the `root` as username and `test{1,2,3}` for the password. | 117 | with the `root` as username and `test{1,2,3}` for the password. |
118 | |||
119 | |||
120 | ### Unit tests | ||
121 | |||
122 | To run unit tests, you need to build the application first: | ||
123 | |||
124 | ``` | ||
125 | $ npm run build | ||
126 | $ npm test | ||
127 | ``` | ||