From b2d5a6e3b6e7000c62cc47806cf5865b32c5b019 Mon Sep 17 00:00:00 2001 From: csantosm <4a.santos@gmail.com> Date: Fri, 8 Apr 2022 13:52:12 +0200 Subject: [PATCH] openvidu-components: Moved docs config files under library directory --- openvidu-components-angular/README.md | 39 ++++++++-- openvidu-components-angular/package.json | 8 +-- .../projects/openvidu-angular/README.md | 67 +++++------------- .../openvidu-angular}/doc/.compodocrc.json | 9 +-- .../additionalPanelsDirective-example.gif | Bin .../doc/assets/chatPanelDirective-example.png | Bin .../doc/assets/layoutDirective-example.png | Bin .../doc/assets/panelDirective.gif | Bin .../participantPanelItemDirective-example.gif | Bin ...pantPanelItemElementsDirective-example.gif | Bin .../participantsPanelDirective-example.png | Bin .../doc/assets/streamDirective-example.png | Bin ...lbarAdditionalButtonsDirective-example.png | Bin ...dditionalPanelButtonsDirective-example.png | Bin .../doc/assets/toolbardirective-example.png | Bin .../projects/openvidu-angular/doc/favicon.ico | Bin 0 -> 5430 bytes .../openvidu-angular}/doc/style.css | 0 .../openvidu-angular/doc/tsconfig.doc.json | 16 +++++ .../openvidu-angular/tsconfig.lib.json | 3 +- .../src/doc/tsconfig.doc.json | 15 ---- 20 files changed, 78 insertions(+), 79 deletions(-) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/.compodocrc.json (74%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/additionalPanelsDirective-example.gif (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/chatPanelDirective-example.png (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/layoutDirective-example.png (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/panelDirective.gif (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/participantPanelItemDirective-example.gif (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/participantPanelItemElementsDirective-example.gif (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/participantsPanelDirective-example.png (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/streamDirective-example.png (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/toolbarAdditionalButtonsDirective-example.png (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/toolbarAdditionalPanelButtonsDirective-example.png (100%) rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/assets/toolbardirective-example.png (100%) create mode 100644 openvidu-components-angular/projects/openvidu-angular/doc/favicon.ico rename openvidu-components-angular/{src => projects/openvidu-angular}/doc/style.css (100%) create mode 100644 openvidu-components-angular/projects/openvidu-angular/doc/tsconfig.doc.json delete mode 100644 openvidu-components-angular/src/doc/tsconfig.doc.json diff --git a/openvidu-components-angular/README.md b/openvidu-components-angular/README.md index 848b002d..3c8f3f69 100644 --- a/openvidu-components-angular/README.md +++ b/openvidu-components-angular/README.md @@ -1,12 +1,43 @@ -# Openvidu Angular +# Openvidu Angular TestAPP -The easier way to build powerful OpenVidu videoconference frontend applications. -How to install: +## Architechture ``` -npm install openvidu-angular +openvidu-components-angular +│ +└─── src (openvidu-components-testapp) +│ +└───projects + │ + └─── openvidu-angular +``` + +## How to develop with ease: + +Run `ng serve` for a dev server. + +Run, in a new terminal, `npm run lib:serve` for serving the openvidu-angular library with live reload for listening changes + +## Code scaffolding + +For generate new components in openvidu-angular: + +```bash +ng g component components/component-name --project=openvidu-angular ``` +## Build library +```bash +npm run lib:build +``` + +## Publishing + +After the library is built, tun the following command: + +```bash +cd dist/ && npm publish +``` diff --git a/openvidu-components-angular/package.json b/openvidu-components-angular/package.json index ff5d6086..b46e0e97 100644 --- a/openvidu-components-angular/package.json +++ b/openvidu-components-angular/package.json @@ -8,13 +8,13 @@ "build": "ng build openvidu-components-testapp --configuration production", "lib:serve": "ng build openvidu-angular --watch", "lib:build": "ng build openvidu-angular --configuration production && cd ./dist/openvidu-angular && npm pack", - "lib:copy": "cp dist/openvidu-angular/openvidu-angular-*.tgz ../openvidu-tutorials/openvidu-angular-components", + "lib:copy": "cp dist/openvidu-angular/openvidu-angular-*.tgz ../../openvidu-tutorials/openvidu-call/openvidu-call-front", "lib:test": "ng test openvidu-angular --no-watch --code-coverage", "lib:e2e": "tsc --project ./e2e && npx mocha --recursive --timeout 30000 ./e2e/dist/angular.test.js", "lib:e2e-ci": "cross-env LAUNCH_MODE=CI npm run lib:e2e", - "lib:doc-build": "npx compodoc -p src/doc/tsconfig.doc.json -c src/doc/.compodocrc.json", - "lib:clean-copy": "rm -rf ../../openvidu.io-docs/docs/api/openvidu-angular && cp -r ./docs/openvidu-angular/ ../../openvidu.io-docs/docs/api/openvidu-angular", - "lib:doc-serve": "npx compodoc -p src/doc/tsconfig.doc.json --watch --serve -c src/doc/.compodocrc.json", + "doc:build": "cd projects/openvidu-angular && npx compodoc -p ./doc/tsconfig.doc.json -c ./doc/.compodocrc.json", + "doc:clean-copy": "rm -rf ../../openvidu.io-docs/docs/api/openvidu-angular && cp -r ./docs/openvidu-angular/ ../../openvidu.io-docs/docs/api/openvidu-angular", + "doc:serve": "cd projects/openvidu-angular && npx compodoc -p ./doc/tsconfig.doc.json --watch --serve -c ./doc/.compodocrc.json", "webcomponent:build": "./node_modules/@angular/cli/bin/ng.js build openvidu-webcomponent --configuration production && node ./openvidu-webcomponent-build.js", "webcomponent:serve-testapp": "npx http-server ./e2e/webcomponent-app/", "webcomponent:e2e": "tsc --project ./e2e && npx mocha --recursive --timeout 30000 ./e2e/dist/webcomponent.test.js", diff --git a/openvidu-components-angular/projects/openvidu-angular/README.md b/openvidu-components-angular/projects/openvidu-angular/README.md index 3502ba67..e480887b 100644 --- a/openvidu-components-angular/projects/openvidu-angular/README.md +++ b/openvidu-components-angular/projects/openvidu-angular/README.md @@ -1,63 +1,28 @@ # openvidu-angular -openvidu-angular is a library generated with the aim of facilitate the customization of videconference app provides by OpenVidu, providing powerful ready-to-use components. +The easier way to build powerful OpenVidu videoconference frontend applications. -This library is an Angular library based on Angular projections - -## Code scaffolding - -## Architechture +## How to install ``` -openvidu-components-angular -│ -└─── src (openvidu-components-testapp) -│ -└───projects - │ - └─── openvidu-angular +npm install openvidu-angular@latest ``` -## Development server +## Ho to use it -Run `ng serve` for a dev server. - -Run, in a new terminal, `npm run lib:serve` for serving the openvidu-angular library with live reload - -## Code scaffolding - -For generate new components in openvidu-angular: - -```bash -ng g component components/component-name --project=openvidu-angular -``` - - -## Build - -```bash -npm run lib:build -``` - -## Publishing - -After the library is built, tun the following command: - -```bash -cd dist/ && npm publish -``` - -## How to use in an Angular project - -Importing library module in yout `app.module.ts` +In your `app.module.ts`: ```typescript +import { OpenViduAngularConfig, OpenViduAngularModule } from 'openvidu-angular'; + +const config: OpenViduAngularConfig = { + production: environment.production +}; + @NgModule({ - imports: [ - BrowserModule, - OpenviduAngularModule.forRoot({ - environment: environment - }), - ... - ]}) + imports: [ + ... + OpenViduAngularModule.forRoot(config) + ] +}) ``` diff --git a/openvidu-components-angular/src/doc/.compodocrc.json b/openvidu-components-angular/projects/openvidu-angular/doc/.compodocrc.json similarity index 74% rename from openvidu-components-angular/src/doc/.compodocrc.json rename to openvidu-components-angular/projects/openvidu-angular/doc/.compodocrc.json index 2b9eb124..638fd128 100644 --- a/openvidu-components-angular/src/doc/.compodocrc.json +++ b/openvidu-components-angular/projects/openvidu-angular/doc/.compodocrc.json @@ -1,6 +1,6 @@ { "name": "OpenVidu Angular Documentation", - "output": "docs/openvidu-angular", + "output": "../../docs/openvidu-angular", "hideGenerator": true, "disableLifeCycleHooks": true, "disableProtected": true, @@ -14,7 +14,8 @@ "disableStyleTab": true, "disableDependencies": true, "theme": "gitbook", - "customFavicon": "src/favicon.ico", - "extTheme": "src/doc/", - "assetsFolder": "src/doc/assets" + "customFavicon": "doc/favicon.ico", + "extTheme": "doc/", + "assetsFolder": "doc/assets" + } diff --git a/openvidu-components-angular/src/doc/assets/additionalPanelsDirective-example.gif b/openvidu-components-angular/projects/openvidu-angular/doc/assets/additionalPanelsDirective-example.gif similarity index 100% rename from openvidu-components-angular/src/doc/assets/additionalPanelsDirective-example.gif rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/additionalPanelsDirective-example.gif diff --git a/openvidu-components-angular/src/doc/assets/chatPanelDirective-example.png b/openvidu-components-angular/projects/openvidu-angular/doc/assets/chatPanelDirective-example.png similarity index 100% rename from openvidu-components-angular/src/doc/assets/chatPanelDirective-example.png rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/chatPanelDirective-example.png diff --git a/openvidu-components-angular/src/doc/assets/layoutDirective-example.png b/openvidu-components-angular/projects/openvidu-angular/doc/assets/layoutDirective-example.png similarity index 100% rename from openvidu-components-angular/src/doc/assets/layoutDirective-example.png rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/layoutDirective-example.png diff --git a/openvidu-components-angular/src/doc/assets/panelDirective.gif b/openvidu-components-angular/projects/openvidu-angular/doc/assets/panelDirective.gif similarity index 100% rename from openvidu-components-angular/src/doc/assets/panelDirective.gif rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/panelDirective.gif diff --git a/openvidu-components-angular/src/doc/assets/participantPanelItemDirective-example.gif b/openvidu-components-angular/projects/openvidu-angular/doc/assets/participantPanelItemDirective-example.gif similarity index 100% rename from openvidu-components-angular/src/doc/assets/participantPanelItemDirective-example.gif rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/participantPanelItemDirective-example.gif diff --git a/openvidu-components-angular/src/doc/assets/participantPanelItemElementsDirective-example.gif b/openvidu-components-angular/projects/openvidu-angular/doc/assets/participantPanelItemElementsDirective-example.gif similarity index 100% rename from openvidu-components-angular/src/doc/assets/participantPanelItemElementsDirective-example.gif rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/participantPanelItemElementsDirective-example.gif diff --git a/openvidu-components-angular/src/doc/assets/participantsPanelDirective-example.png b/openvidu-components-angular/projects/openvidu-angular/doc/assets/participantsPanelDirective-example.png similarity index 100% rename from openvidu-components-angular/src/doc/assets/participantsPanelDirective-example.png rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/participantsPanelDirective-example.png diff --git a/openvidu-components-angular/src/doc/assets/streamDirective-example.png b/openvidu-components-angular/projects/openvidu-angular/doc/assets/streamDirective-example.png similarity index 100% rename from openvidu-components-angular/src/doc/assets/streamDirective-example.png rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/streamDirective-example.png diff --git a/openvidu-components-angular/src/doc/assets/toolbarAdditionalButtonsDirective-example.png b/openvidu-components-angular/projects/openvidu-angular/doc/assets/toolbarAdditionalButtonsDirective-example.png similarity index 100% rename from openvidu-components-angular/src/doc/assets/toolbarAdditionalButtonsDirective-example.png rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/toolbarAdditionalButtonsDirective-example.png diff --git a/openvidu-components-angular/src/doc/assets/toolbarAdditionalPanelButtonsDirective-example.png b/openvidu-components-angular/projects/openvidu-angular/doc/assets/toolbarAdditionalPanelButtonsDirective-example.png similarity index 100% rename from openvidu-components-angular/src/doc/assets/toolbarAdditionalPanelButtonsDirective-example.png rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/toolbarAdditionalPanelButtonsDirective-example.png diff --git a/openvidu-components-angular/src/doc/assets/toolbardirective-example.png b/openvidu-components-angular/projects/openvidu-angular/doc/assets/toolbardirective-example.png similarity index 100% rename from openvidu-components-angular/src/doc/assets/toolbardirective-example.png rename to openvidu-components-angular/projects/openvidu-angular/doc/assets/toolbardirective-example.png diff --git a/openvidu-components-angular/projects/openvidu-angular/doc/favicon.ico b/openvidu-components-angular/projects/openvidu-angular/doc/favicon.ico new file mode 100644 index 0000000000000000000000000000000000000000..0e2249ada68ec5cab2034721dc193285c27175b5 GIT binary patch literal 5430 zcmc&&eN2^Q6o2ox;0z74F{f9TU#+!9X2#sY&6#cG+%jk7$GvdHRGeG+hii#qr9`BK zC}qeHvGgi7)2x{@AZJeQ2i$vM6vot;IU_|SM7+HB^gGY{zHsji5d!CRKhN_%yyy9y z=RD^*=iDnvI!P}LA1>iDPFi7n3LB+bNp^oNLalA8=H z`-6iYNhVd-0{wN8JM*q}0bsYHpWyM3&HpH+LU-f&>6Fv>650J0N)zjuDZSc6C3#&o z_*8vxN9x<4|6}uZ>X2_!&8_cgL&Ni8P1fJjXZ?H%g+e5UI_YNcD%N;b@b^{!L~|as zb>5(}El$d8mIy_@DizA(Ef{Umop0o%=3L z^zNk@HLHP)NK~()6z}r(9R;IG5d)tho~Gi=Phk!9{FF1`IJgHmKAUu|POBE<&`n0{ z`~Z38{s^(X>5?n*o?(vf0mpJ*5OLQf2{sP^oM*-XGXX8nWQp8_iLj5h--j)QuU!4l zcm1^+@nJ!H#Q|OZ7U$!lB*+;+9Dv+6c(yQ?ig?KRuwfJA2(}$O93#xR6=(vGv*`&y z~xQi3P znSt>+$PP%p-|K*(fL5#6->6em58#f9dwT`8?80~sWW3~-#d&2N8zSU^9Ld0NMuE9` zU0^h@05}9(1DKb=<5>W|Bh~^3^C#l|mcS33GlBq1_=8XjLYX?ZoD}Q18pHgh+Z66- ze$}R7*k=mX&IQf`8gEb?pMo3@gvTHA^LejSIn_MHHi(?nVsPI+KE`|0k$G@(@{ufk za@hw`GHPh@;V|Gi<mXv<+e z?JUxZx*lZ%pG7N>0j{Tk)4)w2h#25=kKmu+-A8Zu9~bq?9x%)HTCzBv z<}(v)1WdH7#zYzCO!UcqJ;5j8e$dXO7+miGTFj}u8oyGnCVO|&BL7&yuk%i zsKG{Z1cr3|jsG4FTb-HKRv4)`Ul+lTz4KX=g1b=NZ`i&g`KPG-4s~s=+cv*}R@5fY z^4bx!s75b1H9NxVI(!8m80m{I2Zui`V8NdClu`E>xo&(z{#z#~@8WCVA4-dTdicT8 z z^&i{7;OFL!i&WH<-o?MF$|U?hxcu7wWwjTU;e#OEk^iAfw|%th58DIf&uq~6m3`ll z+vv~sU(ws|L~J~V80GI655oUS{H_4L!-1#x4w~zmNelgx=yl(OK4W2E0;N`2gZaB-FQW#Z2Y(}YtARXVOz-?$ zhq`ST!m( zi)i-rQ~rkcXLa|*I`Mr#?Y$f-H}m%b?o0kRPC_@yT2a&0b85DL6Me7fyL#Eb=7)Yt z<+qnctna`%57RiqCFc1ItiTf3xEV5c5b-Y7nuT@a!Z~{y<30WkGz^lziwzJVMc>6e TedKQfJ#jzGxv-xC9?I}vocwV} literal 0 HcmV?d00001 diff --git a/openvidu-components-angular/src/doc/style.css b/openvidu-components-angular/projects/openvidu-angular/doc/style.css similarity index 100% rename from openvidu-components-angular/src/doc/style.css rename to openvidu-components-angular/projects/openvidu-angular/doc/style.css diff --git a/openvidu-components-angular/projects/openvidu-angular/doc/tsconfig.doc.json b/openvidu-components-angular/projects/openvidu-angular/doc/tsconfig.doc.json new file mode 100644 index 00000000..eee9aaee --- /dev/null +++ b/openvidu-components-angular/projects/openvidu-angular/doc/tsconfig.doc.json @@ -0,0 +1,16 @@ +{ + "include": [ + "../src/lib/components/**/*.ts", + "../src/lib/directives/**/*.ts", + "../src/lib/services/**/*.ts", + "../src/lib/models/**/*.ts", + "../src/lib/pipes/**/*.ts", + "../../../src/app/openvidu-webcomponent/**/*.ts", + ], + "exclude": [ + "src/test.ts", + "../src/lib/**/*.mock.ts", + "../src/lib/**/*.spec.ts", + + ], +} \ No newline at end of file diff --git a/openvidu-components-angular/projects/openvidu-angular/tsconfig.lib.json b/openvidu-components-angular/projects/openvidu-angular/tsconfig.lib.json index b77b13c0..2940f936 100644 --- a/openvidu-components-angular/projects/openvidu-angular/tsconfig.lib.json +++ b/openvidu-components-angular/projects/openvidu-angular/tsconfig.lib.json @@ -10,6 +10,7 @@ }, "exclude": [ "src/test.ts", - "**/*.spec.ts" + "**/*.spec.ts", + "**/*.mock.ts" ] } diff --git a/openvidu-components-angular/src/doc/tsconfig.doc.json b/openvidu-components-angular/src/doc/tsconfig.doc.json deleted file mode 100644 index a95801dc..00000000 --- a/openvidu-components-angular/src/doc/tsconfig.doc.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "include": [ - "../../projects/openvidu-angular/src/lib/components/**/*.ts", - "../../projects/openvidu-angular/src/lib/directives/**/*.ts", - "../../projects/openvidu-angular/src/lib/services/**/*.ts", - "../../projects/openvidu-angular/src/lib/models/**/*.ts", - "../../projects/openvidu-angular/src/lib/pipes/**/*.ts", - "../app/openvidu-webcomponent/**/*.ts" - ], - "exclude": [ - "src/test.ts", - "../../projects/openvidu-angular/src/lib/**/*.mock.ts", - "../../projects/openvidu-angular/src/lib/**/*.spec.ts" - ], -} \ No newline at end of file