aboutsummaryrefslogtreecommitdiffhomepage
path: root/.github
diff options
context:
space:
mode:
authorChocobozzz <me@florianbigard.com>2023-02-16 16:45:49 +0100
committerChocobozzz <me@florianbigard.com>2023-02-16 16:47:13 +0100
commit29ff7889637cd82c3c531bd5b085a23e7d463356 (patch)
treed68d85ebe3d9328231f85f212f84dacee3bceea7 /.github
parentd270d6a0426e4f33dc8ffbf7d1dde991ccaad921 (diff)
downloadPeerTube-29ff7889637cd82c3c531bd5b085a23e7d463356.tar.gz
PeerTube-29ff7889637cd82c3c531bd5b085a23e7d463356.tar.zst
PeerTube-29ff7889637cd82c3c531bd5b085a23e7d463356.zip
Add contributing guide for embed
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md11
1 files changed, 11 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 2f1774756..fcb803e25 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -17,6 +17,7 @@ Interested in contributing? Awesome!
17 - [Server side](#server-side) 17 - [Server side](#server-side)
18 - [Client side](#client-side) 18 - [Client side](#client-side)
19 - [Client and server side](#client-and-server-side) 19 - [Client and server side](#client-and-server-side)
20 - [Embed](#embed)
20 - [RTL layout](#rtl-layout) 21 - [RTL layout](#rtl-layout)
21 - [Testing](#testing) 22 - [Testing](#testing)
22 - [Unit/integration tests](#unitintegration-tests) 23 - [Unit/integration tests](#unitintegration-tests)
@@ -169,6 +170,16 @@ and the web server is automatically restarted.
169$ npm run dev 170$ npm run dev
170``` 171```
171 172
173### Embed
174
175The embed is a standalone application built using Webpack.
176The generated files (HTML entrypoint and multiple JS and CSS files) are served by the PeerTube server (behind `localhost:9000/videos/embed/:videoUUID` or `localhost:9000/video-playlists/embed/:playlistUUID`).
177The following command will compile embed files and run the PeerTube server:
178
179```
180$ npm run dev:embed
181```
182
172### RTL layout 183### RTL layout
173 184
174To test RTL layout using `ar` locale: 185To test RTL layout using `ar` locale: