openvidu-components: Moved docs config files under library directory

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
+```

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",
+    "doc:build": "cd projects/openvidu-angular && npx compodoc -p ./doc/tsconfig.doc.json -c ./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",
+    "doc: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: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",

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
+## How to install
-
-## Code scaffolding
-
-## Architechture
 
 ```
-openvidu-components-angular
+npm install openvidu-angular@latest
-│
-└─── src (openvidu-components-testapp)
-│
-└───projects
-    │
-	└─── openvidu-angular
 ```
 
-## Development server
+## Ho to use it
 
-Run `ng serve` for a dev server.
+In your `app.module.ts`:
-
-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`
 
 ```typescript
+import { OpenViduAngularConfig, OpenViduAngularModule } from 'openvidu-angular';
+
+const config: OpenViduAngularConfig = {
+    production: environment.production
+};
+
 @NgModule({
-  imports: [
+    imports: [
-    BrowserModule,
+        ...
-    OpenviduAngularModule.forRoot({
+        OpenViduAngularModule.forRoot(config)
-      environment: environment
+    ]
-    }),
+})
-    ...
- ]})
 ```

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",
+	"customFavicon": "doc/favicon.ico",
-	"extTheme": "src/doc/",
+	"extTheme": "doc/",
-	"assetsFolder": "src/doc/assets"
+	"assetsFolder": "doc/assets"
+
 }

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",
+
+	],
+}

openvidu-components-angular/projects/openvidu-angular/tsconfig.lib.json

@@ -10,6 +10,7 @@
   },
   "exclude": [
     "src/test.ts",
-    "**/*.spec.ts"
+    "**/*.spec.ts",
+    "**/*.mock.ts"
   ]
 }

openvidu-components-angular/src/doc/tsconfig.doc.json

@@ -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"
-	],
-}