peekaboo-server v0.0.16-dev

peekaboo-server

:ghost: peekaboo-server is a reverse proxy for test doubles, for easily stub backend http/s calls, agnostically to its architecture.

Inspired by polly.js, anyproxy, mitmproxy, mockserver, wiremock, lightproxy, Google Chrome DevTools Network panel and maybe more.
Batteries included.

WORK IN PROGRESS

Quick start

npm i -g peekaboo-server
peekaboo-server

curl @todo request first time
curl @todo request with cache

UI

When server is running, it provide its ui interface at /

@todo screenshot

How it works

@todo

Running with https can also allow to use peekaboo-server with mobile applications.

Settings

default settings

@todo

custom settings for my-app.js

peekaboo-server --settings stub-my-app.js

custom settings from my-app.js and override at runtime with env vars

APP_PORT=9123 LOG_LEVEL=debug peekaboo-server --settings my-app.js

available env vars

• APP_PORT, default 8080
• LOG_LEVEL, default warn
• LOG_PRETTY, default false
• RELAY_TIMEOUT, default 20000

https

@todo

Development

server

npm start

ui

cd src/ui
npm run serve

build

npm run build

Contribution

Any contribution is welcome! You can propose a PR or open an issue and explain what you are going to do.

License

The MIT License (MIT)

Copyright (c) 2020 Simone Sanfratello

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.