bee-hook

KO | EN

gitlite — search

#hacktoberfest #typescript #go #machine-learning #linux #macos #windows #kubernetes #vue #pytorch #ios #mcp #openai #open-source

(★ 18)

:fork_and_knife: A simple, zero-configuration command-line hook server

bee-hook Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">:bee: Bee Hook Server :bee:</h1>

<div align="center">
    <code>bee-hook</code> is a simple, zero-configuration command-line hook server. <br>
    It's powerful enough for production usage, but also simple and hackable enough to be used for testing, local development and learning. <em>(inspired by <a href="https://www.npmjs.com/package/http-server" title="http-server">http-server</a>)</em>
    
</div>

----

## Try it now :D

- **API**: https://hook.beetech.global
 - **Client**: https://beetech-global.github.io/bee-hook-client

## Install

npm install bee-hook -g

## Usage

bee-hook [options]

*Now you can visit http://localhost:5000 to view your server*

## Available Options

`-p` Port to use (defaults to 5000)

## API's

### Creates new bin to post your requests

**URL** : `/api/bins`

**Method** : `POST`

**Reponses**

**Code** : `200 OK`

**Content** :

```json
{
    "hash": "<hash>",
    "url": "http://localhost:5000/bin/<hash>"
}
```

___

### Send your requests

**URL** : `/bin/<hash>`

**Method** : `{ POST | GET | PUT | PATCH | DELETE | OPTIONS }`

**Body** :

```json
{
    "name": "Lucas Daiki",
    "Age": "23"
}
```

**Reponses**

**Code** : `200 OK`

**Content** : `{ "id": "<id>" }`

___

### Check your requests

**URL** : `/api/bins/<hash>`

**Method** : `GET`

**Reponses**

**Code** : `200 OK`

**Content** :

```javascript
{
    "created_at": "2018-02-19T21:56:47.942Z",
    "last_update": "2018-02-19T22:02:40.149Z",
    "bins": [
        {
            "id": "1s41xgf",
            "method": "POST",
            "body": {
                "name": "Lucas Daiki",
                "Age": "23"
            },
            "query": {},
            "headers": { ... },
            "created_at": "2018-02-19T22:01:17.784Z"
        },
        {
            "id": "10xjh47",
            "method": "GET",
            "body": { },
            "query": { "test": "123" }, // ?test=123
            "headers": { ... },
            "created_at": "2018-02-19T22:02:40.149Z"
        }
    ],
    "total": 2
}
```

___

### Check single requests

**URL** : `/api/bins/<hash>/<id>`

**Method** : `GET`

**Reponses**

**Code** : `200 OK`

**Content** :

```javascript
{
    "id": "1s41xgf",
    "method": "POST",
    "body": {
        "name": "Lucas Daiki",
        "Age": "23"
    },
    "query": {},
    "headers": { ... },
    "created_at": "2018-02-19T22:01:17.784Z"
}
```

___

### List all bins

**URL** : `/api/bins`

**Method** : `GET`

**Reponses**

**Code** : `200 OK`

**Content** :

```javascript
[
    {
        "hash":"grqjbf8bti",
        "created_at":"2018-02-21T23:24:05.488Z",
        "last_update":"2018-02-21T23:26:00.595Z",
        "total":50
    },
    {
        "hash":"hhyasd12x",
        "created_at":"2018-02-21T23:24:05.488Z",
        "last_update":"2018-02-23T23:26:00.595Z",
        "total":6
    }
]
```

___

### Delete a hash

**URL** : `/api/bins/<hash>`

**Method** : `DELETE`

**Reponses**

**Code** : `200 OK`

**Content** : No Content
___

## Deployment (Heroku)

- Clone the `bee-hook` repository

- Install heroku [See more](https://devcenter.heroku.com/articles/getting-started-with-nodejs#set-up)
 
 - Login Heroku
 ```
 heroku login
 ```
 
 - Create an app on Heroku
 ```
 heroku create
 ```
 
 - Deploy your hook server :D
 ```
 git push heroku master
 ```

- Open the new url 
 ```
 heroku open
 ```

- Configuring self url
```
$ heroku apps:info hook-mock
...
# Web URL: <url>

$ heroku config:set HOST=<url>
```

## Deployment (PM2)

- Clone the `bee-hook` repository
- Add your server key as deployment key in repository
- Edit `ecosystem.conf.js`
- Setup application on server - run this in your machine - `pm2 deploy production setup`
- Deploy application - run this in your machine - `pm2 deploy production --force`

bee-hook

bee-hook Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

bee-hook

bee-hook Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README