Welcome to providence-server 👋

local proxy server, writing response into dataset, and allowing to replay a dataset.

This is a local proxy server. It record the responses, and store it into files. You can also replay stored responses. It can be useful if you're experiencing down times, or for integration testing.

Install

yarn add providence-server

Usage

You can see all options available by using --help option.

providence --help

To use the server, you have to specify the proxy host to call :

providence proxy -h my-awesome-server.fr

By default, datas will be stored into providence node_modules folder, but if you want to store responses in a specific folder, you can use the --data-folder option :

providence  proxy -h my-awesome-server.fr -d ./data

To replay the current dataset, you can use the replay command:

providence replay
# or if you have a specific data folder
providence replay -d ./data

To save a dataset, use the save command:

providence save -n my-dataset-name
# or if you have a specific data folder
providence save -d ./data -n my-dataset-name

To list your datasets, use le list (or ls) command:

providence list
# or if you have a specific data folder
providence list -d ./data

Contributing

Contributions, issues and feature requests are welcome! Feel free to check issues page. You can also take a look at the contributing guide.

Author

👤 Guillaume Lamanda [email protected]

• Github: @guillaumeLamanda

This project was created while I was working for Aumaxpourmoi.

Show your support

Give a ⭐️ if this project helped you!

---

This README was generated with ❤️ by readme-md-generator