From 6f9719b568fad75959a1404b6927b7a278061c41 Mon Sep 17 00:00:00 2001 From: Chocobozzz Date: Tue, 7 Sep 2021 11:47:40 +0200 Subject: [PATCH] Add dev lib documentation --- client/.gitignore | 2 ++ client/src/standalone/player/package.json | 2 +- support/doc/development/lib.md | 10 ++++++++++ 3 files changed, 13 insertions(+), 1 deletion(-) create mode 100644 support/doc/development/lib.md diff --git a/client/.gitignore b/client/.gitignore index a02b6a6cc..7297b43fc 100644 --- a/client/.gitignore +++ b/client/.gitignore @@ -9,3 +9,5 @@ /src/locale/target/player_*.xml /src/locale/target/server_*.xml /e2e/local.log +/src/standalone/player/build +/src/standalone/player/dist diff --git a/client/src/standalone/player/package.json b/client/src/standalone/player/package.json index 985097af5..78b3cd93f 100644 --- a/client/src/standalone/player/package.json +++ b/client/src/standalone/player/package.json @@ -4,7 +4,7 @@ "version": "0.0.4", "description": "API to communicate with the PeerTube player embed", "scripts": { - "test": "echo \"Error: no test specified\" && exit 1" + "build": "../../../node_modules/.bin/tsc && ../../../node_modules/.bin/webpack --mode production --config ./webpack.config.js" }, "repository": { "type": "git", diff --git a/support/doc/development/lib.md b/support/doc/development/lib.md new file mode 100644 index 000000000..6b0372150 --- /dev/null +++ b/support/doc/development/lib.md @@ -0,0 +1,10 @@ +# Lib development documentation + +## @peertube/embed-api + +### Build + +``` +$ cd client/src/standalone/player/ +$ npm run build +```