n0th1ng-else / hummock

Caching responses from real api and use it as the stubbed data
https://www.npmjs.com/package/hummock
MIT License
1 stars 1 forks source link
mock proxy record stubb stubbed-data talkback

hummock

Caching responses from real api and use it as the stubbed data. This is a standalone GUI application which runs PROXY servers for every host you provide in the config file. (see the Usage section)

Powered by Talkback. For those who want to use recording features when test own applications, please use talkback directly.

Rendered by Angular Material

Usage

create hummock.json file in the root with content as listed below. Humock sets the port for each listener automatically, but you can specify it by yourself.

{
    "recordFrom": [
        {
            "host": "https://some-host.com"
        },
        {
            "host": "http://another-host-example-with-custom-port-for-listener.com",
            "port": 8001
        }
    ]
}

run npm start and visit http://localhost:3000. If you have port 3000 busy, you can run PORT=3001 npm start where 3001 is any of your free ports. Hummock will start and you would be able to access new entrypoint on localhost: localhost:6000 and localhost:8001 (considering the config above)

Config schema is located in the project root

Config options

Option Required Default Description
autostart no false Tells hummon to start proxies when app launches
gui no true Turn web ui on/off
recordFrom yes [] Servers that should be proxied (in form of above)

Custom config location

By default, hummock looks for config file in the root folder. You can specify own config path simply running

    npm start -- --config /path/to/config/hummock.json

Credits

Many thanks go to Ignacio Piantanida, who developed a brilliant package Talkback. Hummock is just a wrapper on top of it which allows to run multiple talkback instances and modify snapshot on the fly in browser window. The initial idea was to implement the same as talkback does, so it easily covered most of cases.