ws-reconnect-proxy

Proxy Server that is between a ws server and a ws client. In case of either server / client disconnects graceful or otherwise - initiates/ supports reconnection.

Read more about 📝 design

README Contents:

• How to contribute
• Development Internals

✨ How to contribute

We are very happy to receive and merge your contributions into this repository!

To contribute via pull request, follow these steps:

1. Create an issue describing the feature you want to work on (or have a look at the issues)
2. Write your code, tests and format them with npm run format
3. Create a pull request describing your changes

Your pull request will be reviewed by a maintainer, who will get back to you about any necessary changes or questions.

⚡️ Development Internals

🔨 Installing Dependencies

To install dependencies

npm install

✅ Running the Tests

In order to run the tests, make sure that you have installed dependencies:

npm run test

🎨 Formatting

To reformat files execute

npm run format

🚀 Run proxy

🔧 Before, executing proxy create the config.json by running the following command:

cp lib/config/config.json.sample lib/config/config.json

Additionally, you can configuration your proxy based on your needs. Refer here - config.json.sample

Then execute proxy by running the following command:

npm run start

NOTE: By default it runs in dev environment you can configure your env by the following command:

NODE_ENV=<env> node cluster.js