Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/honzahommer/heapi

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/honzahommer/heapi
Owner: honzahommer
License: mit
Created: 2019-02-03T01:04:13.000Z (almost 6 years ago)
Default Branch: master
Last Pushed: 2019-02-03T01:10:32.000Z (almost 6 years ago)
Last Synced: 2024-10-31T18:56:39.896Z (7 days ago)
Language: JavaScript
Size: 15.6 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # heapi

> Hurricane Electric Free IPv6 Tunnel Broker API

[![Release](https://img.shields.io/github/release/honzahommer/heapi.svg)](https://github.com/honzahommer/heapi/releases/latest)  

[![npm version](https://img.shields.io/npm/v/heapi.svg)](https://www.npmjs.com/package/heapi)    [![Build Status](https://img.shields.io/travis/honzahommer/heapi/master.svg)](https://travis-ci.org/honzahommer/heapi)   [![devDependency Status](https://img.shields.io/david/dev/honzahommer/heapi.svg)](https://david-dm.org/honzahommer/heapi?type=dev)   [![Meteor Atmosphere](https://img.shields.io/badge/meteor-honzahommer%3Aheapi-blue.svg)](https://atmospherejs.com/honzahommer/heapi)

## Install & Running

### The old way

```bash

git clone https://github.com/honzahommer/heapi.git

cd heapi

npm install

npm start

```

### PM2 (Node.js process manager)

```bash

git clone https://github.com/honzahommer/heapi.git

cd heapi

cp ecosystem.config.js.sample ecosystem.config.js

npm install

pm2 startOrRestart ecosystem.config.json

```

### Heroku

[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy)

## Tests

```bash

npm test

```

## Endpoints

```bash

curl localhost:3000

curl localhost:3000/description

curl localhost:3000/serverv6

```