mirror of https://github.com/OpenVidu/openvidu.git
openvidu-components: Updated docs assets
parent
f70053c2f3
commit
c2a393cc51
|
@ -1,33 +1,7 @@
|
||||||
# OpenviduComponents
|
# Openvidu Angular
|
||||||
|
|
||||||
|
The easier way to build powerfull OpenVidu videoconference frontend applications.
|
||||||
|
|
||||||
|

|
||||||
|
|
||||||
|
|
||||||
## Architechture
|
|
||||||
|
|
||||||
```
|
|
||||||
openvidu-components-angular
|
|
||||||
│
|
|
||||||
└─── src (openvidu-components-testapp)
|
|
||||||
│
|
|
||||||
└───projects
|
|
||||||
│
|
|
||||||
└─── openvidu-angular
|
|
||||||
```
|
|
||||||
|
|
||||||
## Development server
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
Run `npm run lib:build` to build the library.See more [here](projects/openvidu-components-angular/README.md)
|
|
||||||
|
|
|
@ -12,7 +12,7 @@
|
||||||
"lib:test": "ng test openvidu-angular --no-watch --code-coverage",
|
"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": "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: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:doc-build": "npx compodoc -p src/doc/tsconfig.doc.json -c src/doc/.compodocrc.json && 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",
|
"lib:doc-serve": "npx compodoc -p src/doc/tsconfig.doc.json --watch --serve -c src/doc/.compodocrc.json",
|
||||||
"webcomponent:build": "./node_modules/@angular/cli/bin/ng.js build openvidu-webcomponent --configuration production && node ./openvidu-webcomponent-build.js",
|
"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:serve-testapp": "npx http-server ./e2e/webcomponent-app/",
|
||||||
|
|
|
@ -6,6 +6,33 @@ This library is an Angular library based on Angular projections
|
||||||
|
|
||||||
## Code scaffolding
|
## Code scaffolding
|
||||||
|
|
||||||
|
## Architechture
|
||||||
|
|
||||||
|
```
|
||||||
|
openvidu-components-angular
|
||||||
|
│
|
||||||
|
└─── src (openvidu-components-testapp)
|
||||||
|
│
|
||||||
|
└───projects
|
||||||
|
│
|
||||||
|
└─── openvidu-angular
|
||||||
|
```
|
||||||
|
|
||||||
|
## Development server
|
||||||
|
|
||||||
|
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
|
## Build
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
|
|
|
@ -15,5 +15,6 @@
|
||||||
"disableDependencies": true,
|
"disableDependencies": true,
|
||||||
"theme": "gitbook",
|
"theme": "gitbook",
|
||||||
"customFavicon": "src/favicon.ico",
|
"customFavicon": "src/favicon.ico",
|
||||||
"extTheme": "src/doc/"
|
"extTheme": "src/doc/",
|
||||||
|
"assetsFolder": "src/assets/images/app.gif"
|
||||||
}
|
}
|
||||||
|
|
Loading…
Reference in New Issue