diff options
Diffstat (limited to '.github')
-rw-r--r-- | .github/CONTRIBUTING.md | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index 56c3b65d1..c5e62e44d 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md | |||
@@ -91,10 +91,10 @@ to install the dependencies. | |||
91 | 1) Fork the Github repository. | 91 | 1) Fork the Github repository. |
92 | 1) Run the following commands. | 92 | 1) Run the following commands. |
93 | ``` | 93 | ``` |
94 | $ git clone https://github.com/Chocobozzz/PeerTube | 94 | git clone https://github.com/Chocobozzz/PeerTube |
95 | $ cd PeerTube | 95 | cd PeerTube |
96 | $ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git | 96 | git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git |
97 | $ yarn install --pure-lockfile | 97 | yarn install --pure-lockfile |
98 | ``` | 98 | ``` |
99 | 99 | ||
100 | Note that development is done on the `develop` branch. If you want to hack on | 100 | Note that development is done on the `develop` branch. If you want to hack on |
@@ -104,7 +104,7 @@ the `yarn install --pure-lockfile` command. | |||
104 | When you create a new branch you should also tell to use your repo for upload | 104 | When you create a new branch you should also tell to use your repo for upload |
105 | not default one. To do just do: | 105 | not default one. To do just do: |
106 | ``` | 106 | ``` |
107 | $ git push --set-upstream me <your branch name> | 107 | git push --set-upstream me <your branch name> |
108 | ``` | 108 | ``` |
109 | 109 | ||
110 | Then, create a postgres database and user with the values set in the | 110 | Then, create a postgres database and user with the values set in the |
@@ -121,8 +121,8 @@ Enter password for new role: peertube | |||
121 | Then enable extensions PeerTube needs: | 121 | Then enable extensions PeerTube needs: |
122 | 122 | ||
123 | ``` | 123 | ``` |
124 | $ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev | 124 | sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev |
125 | $ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev | 125 | sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev |
126 | ``` | 126 | ``` |
127 | 127 | ||
128 | Peertube also requires a running redis server, no special setup is needed for | 128 | Peertube also requires a running redis server, no special setup is needed for |
@@ -141,7 +141,7 @@ You can get a complete PeerTube development setup with Gitpod, a free one-click | |||
141 | To develop on the server-side: | 141 | To develop on the server-side: |
142 | 142 | ||
143 | ``` | 143 | ``` |
144 | $ npm run dev:server | 144 | npm run dev:server |
145 | ``` | 145 | ``` |
146 | 146 | ||
147 | Then, the server will listen on `localhost:9000`. When server source files | 147 | Then, the server will listen on `localhost:9000`. When server source files |
@@ -157,7 +157,7 @@ More detailed documentation is available: | |||
157 | To develop on the client side: | 157 | To develop on the client side: |
158 | 158 | ||
159 | ``` | 159 | ``` |
160 | $ npm run dev:client | 160 | npm run dev:client |
161 | ``` | 161 | ``` |
162 | 162 | ||
163 | The API will listen on `localhost:9000` and the frontend on `localhost:3000`. | 163 | The API will listen on `localhost:9000` and the frontend on `localhost:3000`. |
@@ -175,7 +175,7 @@ File changes are automatically recompiled, injected in the web browser (no need | |||
175 | and the web server is automatically restarted. | 175 | and the web server is automatically restarted. |
176 | 176 | ||
177 | ``` | 177 | ``` |
178 | $ npm run dev | 178 | npm run dev |
179 | ``` | 179 | ``` |
180 | 180 | ||
181 | ### Embed | 181 | ### Embed |
@@ -185,7 +185,7 @@ The generated files (HTML entrypoint and multiple JS and CSS files) are served b | |||
185 | The following command will compile embed files and run the PeerTube server: | 185 | The following command will compile embed files and run the PeerTube server: |
186 | 186 | ||
187 | ``` | 187 | ``` |
188 | $ npm run dev:embed | 188 | npm run dev:embed |
189 | ``` | 189 | ``` |
190 | 190 | ||
191 | ### RTL layout | 191 | ### RTL layout |
@@ -193,7 +193,7 @@ $ npm run dev:embed | |||
193 | To test RTL (right-to-left) layout using `ar` locale: | 193 | To test RTL (right-to-left) layout using `ar` locale: |
194 | 194 | ||
195 | ``` | 195 | ``` |
196 | $ npm run dev -- --ar-locale | 196 | npm run dev -- --ar-locale |
197 | ``` | 197 | ``` |
198 | 198 | ||
199 | ### Testing | 199 | ### Testing |
@@ -211,23 +211,23 @@ Create a PostgreSQL user **with the same name as your username** in order to avo | |||
211 | Then, we can create the databases (if they don't already exist): | 211 | Then, we can create the databases (if they don't already exist): |
212 | 212 | ||
213 | ``` | 213 | ``` |
214 | $ sudo -u postgres createuser you_username --createdb --superuser | 214 | sudo -u postgres createuser you_username --createdb --superuser |
215 | $ createdb -O peertube peertube_test{1,2,3} | 215 | createdb -O peertube peertube_test{1,2,3} |
216 | ``` | 216 | ``` |
217 | 217 | ||
218 | Build the application and flush the old tests data: | 218 | Build the application and flush the old tests data: |
219 | 219 | ||
220 | ``` | 220 | ``` |
221 | $ npm run build | 221 | npm run build |
222 | $ npm run clean:server:test | 222 | npm run clean:server:test |
223 | ``` | 223 | ``` |
224 | 224 | ||
225 | To run 3 nodes: | 225 | To run 3 nodes: |
226 | 226 | ||
227 | ``` | 227 | ``` |
228 | $ NODE_APP_INSTANCE=1 NODE_ENV=test npm start | 228 | NODE_APP_INSTANCE=1 NODE_ENV=test npm start |
229 | $ NODE_APP_INSTANCE=2 NODE_ENV=test npm start | 229 | NODE_APP_INSTANCE=2 NODE_ENV=test npm start |
230 | $ NODE_APP_INSTANCE=3 NODE_ENV=test npm start | 230 | NODE_APP_INSTANCE=3 NODE_ENV=test npm start |
231 | ``` | 231 | ``` |
232 | 232 | ||
233 | Then you will get access to the three nodes at `http://127.0.0.1:900{1,2,3}` | 233 | Then you will get access to the three nodes at `http://127.0.0.1:900{1,2,3}` |