Add contributing guide for embed

pull/5615/head
Chocobozzz 2023-02-16 16:45:49 +01:00
parent d270d6a042
commit 29ff788963
No known key found for this signature in database
GPG Key ID: 583A612D890159BE
1 changed files with 11 additions and 0 deletions

View File

@ -17,6 +17,7 @@ Interested in contributing? Awesome!
- [Server side](#server-side) - [Server side](#server-side)
- [Client side](#client-side) - [Client side](#client-side)
- [Client and server side](#client-and-server-side) - [Client and server side](#client-and-server-side)
- [Embed](#embed)
- [RTL layout](#rtl-layout) - [RTL layout](#rtl-layout)
- [Testing](#testing) - [Testing](#testing)
- [Unit/integration tests](#unitintegration-tests) - [Unit/integration tests](#unitintegration-tests)
@ -169,6 +170,16 @@ and the web server is automatically restarted.
$ npm run dev $ 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 ### RTL layout
To test RTL layout using `ar` locale: To test RTL layout using `ar` locale: