Skip to content

A modular service for communication between scripts

License

Notifications You must be signed in to change notification settings

ShackledMars261/is-c

Repository files navigation

IS-C - InterScript-Communications

A modular service for communication between scripts and services

Features:

  • No more worrying about dynamic ips, all network information is gathered for you
  • Event and Event Listeners for communication between connected services
  • Runs both in and out of Docker

Setup

  1. Download and setup Docker Desktop
  2. git clone [email protected]:ShackledMars261/is-c.git
  3. docker-compose up -d --build

Running Server in Docker:

  1. Make sure both services start up
  2. Connect your service

Running Server outside Docker:

  1. Stop the app service (leave the db service running, unless you're using a local install of MySQL)
  2. cd is-c
  3. pip install -r requirements.txt
  4. python server.py
  5. Connect your service

Creating a service

  • A sample service is provided in the examples directory

Requests

  • A postman collection with the major requests is provided in the examples directory

TODO

  • Fix bugs
  • Come up with name (current one is pretty trash)
  • Update README
  • Use more features in the example
  • Update wellness check to check connected services (new client endpoint)
  • GETIP and GETPORT actions (for clients)
  • Run a wellness check to all connected services on a time interval (i.e., 1 hour, configurable)
  • Make web dashboard to view current services and listeners

About

A modular service for communication between scripts

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published