https://github.com/configcat/ng-configcat-publicapi

ConfigCat Public API client for Angular. ConfigCat is a hosted feature flag service: https://configcat.com. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.
https://github.com/configcat/ng-configcat-publicapi

angular api configcat feature-flags feature-management feature-toggles public-api remote-config swagger

Last synced: 11 months ago
JSON representation

ConfigCat Public API client for Angular. ConfigCat is a hosted feature flag service: https://configcat.com. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

• Host: GitHub
• URL: https://github.com/configcat/ng-configcat-publicapi
• Owner: configcat
• License: mit
• Created: 2020-02-28T09:35:18.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2024-09-09T14:30:54.000Z (over 1 year ago)
• Last Synced: 2024-09-09T17:40:48.735Z (over 1 year ago)
• Topics: angular, api, configcat, feature-flags, feature-management, feature-toggles, public-api, remote-config, swagger
• Language: TypeScript
• Homepage: https://configcat.com
• Size: 1.45 MB
• Stars: 7
• Watchers: 5
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

          
# ConfigCat Public API client for Angular (ng-configcat-publicapi)

[![Public API Angular CI](https://github.com/configcat/ng-configcat-publicapi/actions/workflows/ng-configcat-publicapi-ci.yml/badge.svg?branch=master)](https://github.com/configcat/ng-configcat-publicapi/actions/workflows/ng-configcat-publicapi-ci.yml) ![License](https://img.shields.io/github/license/configcat/ng-configcat-publicapi.svg) \

[![NPM](https://nodei.co/npm/ng-configcat-publicapi.png)](https://nodei.co/npm/ng-configcat-publicapi/)

ConfigCat Public API client for Angular. ConfigCat is a hosted feature flag service: https://configcat.com. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

The client is generated by [Swagger](https://github.com/swagger-api/swagger-codegen) 

Swagger from the [ConfigCat Public API](https://test-api.configcat.com/docs/index.html).

## Getting Started

### 1. Install package:

*via NPM [package](https://npmjs.com/package/ng-configcat-publicapi):*

```PowerShell

npm i ng-configcat-publicapi

```

### 2. Initialization:

In your Angular project:

#### Without configuring providers

```

import { ApiModule } from 'ng-configcat-publicapi';

import { HttpClientModule } from '@angular/common/http';

@NgModule({

    imports: [

        ApiModule,

        // make sure to import the HttpClientModule in the AppModule only,

        // see https://github.com/angular/angular/issues/20575

        HttpClientModule

    ],

    declarations: [ AppComponent ],

    providers: [],

    bootstrap: [ AppComponent ]

})

export class AppModule {}

```

#### With configuring providers

```

import { ApiModule, Configuration, ConfigurationParameters } from 'ng-configcat-publicapi';

export function apiConfigFactory (): Configuration => {

  const params: ConfigurationParameters = {

    // set configuration parameters here.

  }

  return new Configuration(params);

}

@NgModule({

    imports: [ ApiModule.forRoot(apiConfigFactory) ],

    declarations: [ AppComponent ],

    providers: [],

    bootstrap: [ AppComponent ]

})

export class AppModule {}

```

### 3. Usage:

```

import { ProductsService } from 'ng-configcat-publicapi';

export class AppComponent {

    constructor(private productsService: ProductsService) { }

    getProducts() {

       this.productsService.v1ProductsGet().subscribe(products => {

           // Do something with the products.

       });

    }

}

```