After cloning the repo and running npm install it would be useful to run npm run install:all this will install the dependencies for all the sub projects (see below) that need them. This gets things into a good starting place for development.
I have done my best to include a dev script for all of the folders below where it makes sense. So simply running npm run dev should get you into a running state. This will either be a live-reload process where changes will be detected and rebuilt or the current piece will be built with what is in your working directory and launched (launcher). The script should also take care of the linking for the libraries (@showbridge/cli, @showbridge/lib) where necessary.
lib is the actual meat of showbridge defining a library that is then wrapped up and fronted by other sections
published as @showbridge/lib
cli is a script using commander.js that wraps the library above into an executable script with options like where to load a config from, log levels, etc.
published as @showbridge/cli
the launcher is an electron app that wraps the main.js script into a desktop app setting up things like config directory, logs, etc.
an angular web interface for managing a running instance of the main.js executable this is bundled into the launcher and served on whatever port the user has configured for the http protocol
published as showbridge-webui
general build/dev scripts
schema for the router config JSON file
- would be nice to split this up
source for cloud server portion of showbridge which is basically just a socket.io server with some config options for admin-ui auth, redis adapter, log-level, etc.