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:

| Parameter | Description | |------------|-------------------------------------------------------------------------------------------------------| | stream | UUID for the stream, such as the ActivityPub stream UUID. | | space | Space Identifier, such as a UUID or the ActivityPub Channel Identifier like [email protected] | | token | JWT user token provided by the Shig instance | | api-prefix | Prefix path for the Shig REST API. Useful when the API is behind a proxy. | | user | Current user Identifier, such as a ActivityPub Identifier like [email protected] |

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.