Giter Site home page Giter Site logo

socket-man's Introduction

Socket-Man

A tool for simple testing your socket client via using simple Socket.io server

Screenshots

There are screenshots of main page of Socket-Man and special test page which was used during development:

Socket-man

Socket-man

Why

Let's assume we develop a front-end application that uses socket connections. But at the moment we don't have access to server or can't emit events from it to client.
So, how can we imitate incoming socket events for testing purposes?
This is why given tool was created.

Features

With Socket-Man you can:

  • send events from server to client via convenient admin shell
  • subscribe on any event that client can emit to server
  • look over all events with their data and possibility to simply copy content
  • save your events for further using

Using via Docker

The image is available on Docker Hub, so you can just type:

$ docker run -p 9710:9710 daminort/socket-man

The Admin-shell will be available on localhost:9710

Note. You can choose any port you like as well, for example, 7777:

docker run -p 9710:7777 daminort/socket-man

Using via Docker-Compose

In this case you need to clone repository:

$ git clone https://github.com/daminort/socket-man.git
$ cd socket-man
$ docker-compose up --build

Note. You can use instead of latter command npm-script:

npm run compose-up

Using via Source

In this case you need to start server and client manually and separately. Server will be listening port 9710 meanwhile Client will start on port 9711.
Also you can start test page which demonstrate working example.

$ git clone https://github.com/daminort/socket-man.git
$ cd socket-man

$ cd server
$ npm start

$ cd client
$ npm start

$ cd test
$ npm start

Note. You can change server port by editing .env files:
server/.env, variable APP_PORT
client/.env.local, variable REACT_APP_SOCKET_SERVER_PORT

For changing client port you need to edit script start in package.json:
"start": "PORT=9711 react-scripts start"

License

MIT © Daminort

socket-man's People

Contributors

daminort avatar vladislav-khobot avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.