Skip to content

Latest commit

 

History

History
117 lines (79 loc) · 6.11 KB

README.md

File metadata and controls

117 lines (79 loc) · 6.11 KB

KMCng Application

Gitter chat

Kaltura Management Console HTML5 based application (a.k.a KMCng). Should replace the existing KMC flash based application.

KMCng application uses the following technologies and conventions:

  • Angular CLI to manage the application (dev)ops.
  • TypeScript language (superset of Javascript).
  • Stylesheets with SASS (not required, it supports regular css too).
  • Error reported with TSLint and Codelyzer.
  • Best practices in file and application organization for Angular 2.

Quick start

Prerequisites

Project build options

KKC-ng solution is comprised of many packages; The KMC-ng application is developed along-side the kaltura-ng packages and mc-theme package. To simplify local development we created a tool that automagically bind them together as-if they where part of the same repository.

You have two development options as described below.

Option I (the blue pill) - Build this repo (kmc-ng) only to get a running application

This option builds the kmc-ng repo against the Kaltura libraries published on NPM. Note that the build script runs an earlier version of the application which compiles against the published NPM libraries. This version does not include latest features and fixes.

Please do not open issues when using this version as it is not up to date. If you want to create a pull request or open an issue, use the second option.

# clone our repo
$ git clone https://github.com/kaltura/kmc-ng.git 

# change directory to your app
$ cd kmc-ng

# install the dependencies
$ npm install

# checkout latest standalone code
$ npm run checkout-standalone

# sync dependencies to the new branch
$ npm install

# run a local server
$ npm start

Note - if you need to edit the application configuration, change the environment.ts file only after running all of the commands above

Option II (the red pill)- Develop kmc-ng complete solution (multiple repos)

In this option you will clone all the relevant repos to your machine and bind them together. Use this option to develop and create pull requests.

Please read docs/develop kmc-ng solution guide.

Run the application

Run the following command

$ npm start

navigate to http://localhost:4200 in your browser.

Configuring the application endpoints

The Github version configures server endpoints against the Kaltura production server. If you need to configure these enpoint, edit the environment.ts file.

Deploy standalone application

To create a standalone application you will need to build the application:

$ ng build --prod

A distrubted standalone application will be created in the dist/ folder.

Update the base url to match your production environment.

  • Open the index.html file in the dist folder.
  • update the following <base href="/"> to match the relative path this application will be hosted at. Make sure you use / as a suffix of the href value.

KMC-ng solution

KMC-ng is built on-top of several kaltura instrastructure packages. Below is a summary of the core packages being used:

Package Version
kaltura-client npm version
kaltura-common npm version
kaltura-ui npm version
kaltura-primeng-ui npm version
kaltura-typescript-client npm version
@kaltura-ng/mc-theme npm version
Note
  • The version number listed above represent the latest version deployed to npm for each package. This is not necessarily the versions currently in-use by this app. You can review package.json to get the actual packages versions.

FAQ

Where can I create a kaltura account to access the application?

If you already have a Kaltura account you can use its' credentials to login to the kmc-ng application.

Note that any changes to the data will affect your production account. Keep in mind that we are currently under heavy development.

If you don't have an account yet, you can sign-up to a free trial.

License and Copyright Information

All code in this project is released under the AGPLv3 license unless a different license for a particular library is specified in the applicable library path.

Copyright © Kaltura Inc. All rights reserved.