ng-gun v0.0.1

ng-gun

Expose the GUN database to Angular applications.

A simple, lightweight service to expose GUN to your Angular applications.

Installation

The quickest installation is using npm:

npm install --save ng-gun

Alternatively you can clone this repo and build from source:

git clone https://github.com/deztopia/ng-gun.git
cd ng-gun
npm install
npm run build
npm run pack-lib

Configuration

You can pass configuration to ng-gun when it is initially injected into your application. Configuration is simply an object with a peers array and a modules object:

const gunConfig = {
  peers: [],
  modules: {}  
};

You can configure with peers and modules as described in the GUN documentation:

const gunConfig = {
    peers: ['http://yourdomain.com/gun'],
    modules: {
        s3: {
            key: '123',
            secret: '456',
            bucket: 'myapp'
          }
    }
}

Inject ng-gun in the root component of your application, passing in your configuration:

import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';
import { NgGunModule } from 'ng-gun';

@NgModule({
  declarations: [
    AppComponent
  ],
  imports: [
    BrowserModule,
    NgGunModule.forRoot(gunConfig)
  ],
  bootstrap: [AppComponent]
})
export class AppModule { }

Using

Use in your components as with any service. The service exposes the single GUN instance as "gun":

import { Component, OnInit } from '@angular/core';
import { NgGunService } from 'ng-gun';

@Component({
  selector: 'app-home',
  templateUrl: './app-home.component.html',
  styleUrls: ['./app-home.component.scss']
})
export class HomeComponent implements OnInit{
    constructor(private gunService: NgGunService) { }
    
    ngOnInit() {
        let test = this.gunService.gun.get('test');
        test.put({name: 'foo'});
    }
}