From 29ff7889637cd82c3c531bd5b085a23e7d463356 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Thu, 16 Feb 2023 16:45:49 +0100 Subject: Add contributing guide for embed --- .github/CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) (limited to '.github/CONTRIBUTING.md') 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! - [Server side](#server-side) - [Client side](#client-side) - [Client and server side](#client-and-server-side) + - [Embed](#embed) - [RTL layout](#rtl-layout) - [Testing](#testing) - [Unit/integration tests](#unitintegration-tests) @@ -169,6 +170,16 @@ and the web server is automatically restarted. $ npm run dev ``` +### Embed + +The embed is a standalone application built using Webpack. +The 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`). +The following command will compile embed files and run the PeerTube server: + +``` +$ npm run dev:embed +``` + ### RTL layout To test RTL layout using `ar` locale: -- cgit v1.2.3