0.0.2 • Published 2 years ago

@shigde/core v0.0.2

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

Shig Core

Shig Core is an AngularJS library designed to serve as the foundation for the Shig Lobby. It can be also seamlessly integrated into an Angular application. If you are not using Angular, utilize the JavaScript SDK directly via Lobby web component.

Install

npm i @shigde/core

Integrate the Shig Lobby component

Shig Core is used in Shig Web Client. Please use the Shig Web Client as a reference.

To display a Shig Lobby component in your app you need to import the ShigModule by adding the following lines to your app.module.ts file.

import { ShigModule } from '@shigde/core';

@NgModule({
    imports: [
        ShigModule,
    ]
})
class AppModule {
}

Add the <shig-lobby> tag to your own component html like so:

<shig-lobby [stream]="streamId" [space]="spaceId" [token]="userToken" [api-prefix]="" [user]=user-id"></shig-lobby>

Shig Lobby Components Parameters:

ParameterDescription
streamUUID for the stream, such as the ActivityPub stream UUID.
spaceSpace Identifier, such as a UUID or the ActivityPub Channel Identifier like mychannel@video.shig.de
tokenJWT user token provided by the Shig instance
api-prefixPrefix path for the Shig REST API. Useful when the API is behind a proxy.
userCurrent user Identifier, such as a ActivityPub Identifier like user@video.shig.de

Allow Common js

Because shigde/core is using sdp-transform lib add in your angular.json:

"build": {
  "builder": "@angular-devkit/build-angular:browser",
  "options": {
    "allowedCommonJsDependencies": [
      "sdp-transform"
    ],
  }
}

Build

Run ng build core from root directory to build the project. The build artifacts will be stored in the dist/core directory.

0.0.2

2 years ago

0.0.1

2 years ago