Code Monkey home page Code Monkey logo

resgrid / ngxresgridlib Goto Github PK

View Code? Open in Web Editor NEW
3.0 4.0 2.0 1.47 MB

Angular library for utilizing the Resgrid V4 API. Resgrid is a dispatch solution for first responders, businesses and industry.

License: Apache License 2.0

JavaScript 1.48% TypeScript 92.94% HTML 4.61% SCSS 0.97%
first-responder first-responders dispatch emergency-response emergency-management disaster-response disaster-recovery disaster-management typescript angular

ngxresgridlib's Introduction

Ngx-ResgridLib - Angular Library for the Resgrid API

Ngx-ResgridLib is an Angular library used by Resgrid in all of our mobile applications and web applications to interact with the Resgrid API. This library is a foundational element to all of our applications and contains a large cross-section of code used in building our mobile applications which are written in Ionic Framework and Capacitor.

About Resgrid

Resgrid is an open-source Computer Aided Dispatch (CAD) solution for first responders, businesses and industrial environments.

Sign up for your free Resgrid Account Today!

Features

  • V4 API compatible with the v4 version of the Resgrid API
  • RxJS Services for each API utilizing RxJS
  • Authentication Library handles the auth flow and storing of the refresh token

Installation

# Install the library
npm install @resgrid/ngx-resgridlib --save

Getting Started

  import { NgxResgridLibModule } from '@resgrid/ngx-resgridlib';

  let getBaseUrl = (): string => {
    return 'http://localhost:8081';
  }
   
  @NgModule({
    declarations: [
      AppComponent
    ],
    imports: [
      ... ,
   
      NgxResgridLibModule.forRoot({
          baseApiUrl: getBaseUrl, 
          apiVersion: 'v4', 
          clientId: 'test', 
          googleApiKey: '', 
          channelUrl: '', 
          channelHubName: '', 
          logLevel: 0
          }),
    ],
    providers: [],
    bootstrap: [ AppComponent ]
  })
  
  export class AppModule { }

NgxResgridLibModule Options

Setting Description
baseApiUrl The base URL to talk to the Resgrid API (Services) for our hosted production system this is "https://api.resgrid.com". This is a function that should return the string url to the api without nothing past the hostname and/or port.
apiVersion Version of the API to call, currently only `v4` is supported
clientId Just a name to give to your application using this library
googleApiKey Your Google Map account API key
channelUrl The URL to connect to the SignalR hub for our hosted production system this is "https://api.resgrid.com/signalr"
channelHubName The SignalR hub name to connect to receive events for
logLevel Log level for the library 0 = Debug and above, 1 = Warn and above, 2 = Error only, -1 = Off

License

Apache 2.0

ngxresgridlib's People

Contributors

deepsource-autofix[bot] avatar ucswift avatar

Stargazers

 avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.