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 00000000..0e2249ad Binary files /dev/null and b/openvidu-components-angular/projects/openvidu-angular/doc/favicon.ico differ 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