aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-04-04 09:16:53 +0200
committerChocobozzz <me@florianbigard.com>2023-04-04 09:18:06 +0200
commit00ee545c2444c35ed0d37df9f91984246aa36124 (patch)
tree823ab6b93d9b144bc60adef5c69739b0e8fed808 /.github/CONTRIBUTING.md
parentb5f38b78984c69fd2b4270c50ed58a708174b935 (diff)
downloadPeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.tar.gz
PeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.tar.zst
PeerTube-00ee545c2444c35ed0d37df9f91984246aa36124.zip
Remove $ for bash commands
It prevents easy copy
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md38
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.
911) Fork the Github repository. 911) Fork the Github repository.
921) Run the following commands. 921) Run the following commands.
93``` 93```
94$ git clone https://github.com/Chocobozzz/PeerTube 94git clone https://github.com/Chocobozzz/PeerTube
95$ cd PeerTube 95cd PeerTube
96$ git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git 96git remote add me git@github.com:YOUR_GITHUB_USERNAME/PeerTube.git
97$ yarn install --pure-lockfile 97yarn install --pure-lockfile
98``` 98```
99 99
100Note that development is done on the `develop` branch. If you want to hack on 100Note that development is done on the `develop` branch. If you want to hack on
@@ -104,7 +104,7 @@ the `yarn install --pure-lockfile` command.
104When you create a new branch you should also tell to use your repo for upload 104When you create a new branch you should also tell to use your repo for upload
105not default one. To do just do: 105not default one. To do just do:
106``` 106```
107$ git push --set-upstream me <your branch name> 107git push --set-upstream me <your branch name>
108``` 108```
109 109
110Then, create a postgres database and user with the values set in the 110Then, create a postgres database and user with the values set in the
@@ -121,8 +121,8 @@ Enter password for new role: peertube
121Then enable extensions PeerTube needs: 121Then enable extensions PeerTube needs:
122 122
123``` 123```
124$ sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev 124sudo -u postgres psql -c "CREATE EXTENSION pg_trgm;" peertube_dev
125$ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev 125sudo -u postgres psql -c "CREATE EXTENSION unaccent;" peertube_dev
126``` 126```
127 127
128Peertube also requires a running redis server, no special setup is needed for 128Peertube 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
141To develop on the server-side: 141To develop on the server-side:
142 142
143``` 143```
144$ npm run dev:server 144npm run dev:server
145``` 145```
146 146
147Then, the server will listen on `localhost:9000`. When server source files 147Then, the server will listen on `localhost:9000`. When server source files
@@ -157,7 +157,7 @@ More detailed documentation is available:
157To develop on the client side: 157To develop on the client side:
158 158
159``` 159```
160$ npm run dev:client 160npm run dev:client
161``` 161```
162 162
163The API will listen on `localhost:9000` and the frontend on `localhost:3000`. 163The 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
175and the web server is automatically restarted. 175and the web server is automatically restarted.
176 176
177``` 177```
178$ npm run dev 178npm 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
185The following command will compile embed files and run the PeerTube server: 185The following command will compile embed files and run the PeerTube server:
186 186
187``` 187```
188$ npm run dev:embed 188npm run dev:embed
189``` 189```
190 190
191### RTL layout 191### RTL layout
@@ -193,7 +193,7 @@ $ npm run dev:embed
193To test RTL (right-to-left) layout using `ar` locale: 193To test RTL (right-to-left) layout using `ar` locale:
194 194
195``` 195```
196$ npm run dev -- --ar-locale 196npm 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
211Then, we can create the databases (if they don't already exist): 211Then, we can create the databases (if they don't already exist):
212 212
213``` 213```
214$ sudo -u postgres createuser you_username --createdb --superuser 214sudo -u postgres createuser you_username --createdb --superuser
215$ createdb -O peertube peertube_test{1,2,3} 215createdb -O peertube peertube_test{1,2,3}
216``` 216```
217 217
218Build the application and flush the old tests data: 218Build the application and flush the old tests data:
219 219
220``` 220```
221$ npm run build 221npm run build
222$ npm run clean:server:test 222npm run clean:server:test
223``` 223```
224 224
225To run 3 nodes: 225To run 3 nodes:
226 226
227``` 227```
228$ NODE_APP_INSTANCE=1 NODE_ENV=test npm start 228NODE_APP_INSTANCE=1 NODE_ENV=test npm start
229$ NODE_APP_INSTANCE=2 NODE_ENV=test npm start 229NODE_APP_INSTANCE=2 NODE_ENV=test npm start
230$ NODE_APP_INSTANCE=3 NODE_ENV=test npm start 230NODE_APP_INSTANCE=3 NODE_ENV=test npm start
231``` 231```
232 232
233Then you will get access to the three nodes at `http://127.0.0.1:900{1,2,3}` 233Then you will get access to the three nodes at `http://127.0.0.1:900{1,2,3}`