Conference-ui-components NPM

Conference UI Components

The purpose of this project is to build some re-usable conference components for nx-dashboard application.

General info
Technologies
Folder structure
Setup
How to build npm package
How to use the package for local development
Dependencies

General info

This project is an angular project and was generated with Angular CLI version 1.7.3

Technologies

Folder structure

conference-ui-components
├── src
│   ├── app
|   │   └── modules
|   │       ├── conference-calls
|   |       ├── conference-settings
|   │       └── shared
|   ├── assets
|   ├── environments
|   ├── .
|   ├── .
|   ├── .
|   ├── index.html
│   └── main.ts
├── .gitignore
├── .
├── .
├── package.json
├── tsconfig.json
├── tslint.json
└── README.md

conference-calls

This folder contains the components, interfaces, models, services related to conference calls. We can have two types of call Consultation and NxCall and both have live and past information.

conference-settings

This folder contains the components, interfaces, models, services related to conference settings. We have platform conference number and platform conference dial-in there.

shared

This folder contains all the common components, directives, pipes, models, services and other information those are used by other modules.

Setup

To install dependencies and build the project run the following command:

npm install

Once the build is success, run the command below to start using the UI.

npm run start

This will launch the application at http://localhost:3001 in aot compatible mode.

How to build npm package

To prepare the npm package run the following command

npm run package

After successfully running the command, you will get a dist folder in the root path.

How to use the package for local development

Inside the dist folder you will get a file named conference-ui-components-<package-version>.tgz. From other Angular applications on your system that require your component library, you can npm install ../some-relative-path/dist/conference-ui-components-<package-version>.tgz to install your component library into your application.