https://github.com/nucleus-inc/ngipstack

Work in progress
https://github.com/nucleus-inc/ngipstack

angular ipstack ipv4 ipv6 ngipstack

Last synced: 11 months ago
JSON representation

Work in progress

• Host: GitHub
• URL: https://github.com/nucleus-inc/ngipstack
• Owner: Nucleus-Inc
• Created: 2018-06-04T14:56:56.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2018-08-22T14:46:03.000Z (over 7 years ago)
• Last Synced: 2025-01-31T19:35:51.148Z (12 months ago)
• Topics: angular, ipstack, ipv4, ipv6, ngipstack
• Language: JavaScript
• Homepage:
• Size: 134 KB
• Stars: 2
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# ngIpStack

[![Build Status](https://travis-ci.org/Nucleus-Inc/ngIpStack.svg?branch=master)](https://travis-ci.org/Nucleus-Inc/ngIpStack)

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)

[![npm](https://img.shields.io/npm/v/ngipstack.svg)](https://www.npmjs.com/package/ngipstack)

The unofficial [IpStack](https://ipstack.com/) SDK for AngularJS (AKA Angular 1)

## Requirements

- [Angular.js](http://angularjs.org)

## Installation

### Add library

You can get it on npm.

```shell

$ npm install --save ngIpStack

```

```html

```

### Add dependency

```javascript

var app = angular.module('myModule', ['ipStack']);

```

## Usage

### Set your api key

```javascript

app.controller('myController', ['$scope', 'requester',

    function myController($scope, requester) {

        requester.setApiKey('your-api-key-ip-stack');

        console.log(requester.getApiKey());

    }

]);

```

### Get your IP Address

```javascript

app.controller('myController', ['$scope', 'requester',

    function myController($scope, requester) {

        requester.setApiKey('your-api-key-ip-stack');

        requester.getIp().then(function(res){

          var myIpAddress = res.data.ip;

          console.log(myIpAddress);

        });

    }

]);

```

## Build

```

$ yarn install

$ gulp build

```

### Tests

- Unit:

 - Uses [Karma](http://karma-runner.github.io) + [Jasmine](http://jasmine.github.io/)

 - Files: `specs/*.spec.js`

```

$ gulp test

```