Simple UI

Simple UI is a real-time display framework using Angular 14 for the front end display and Node.js 18 as a back end service provider. The front-end part of simpleui (base_app) sends http requests to the backend end part of simpleui (simpleui-server), which in turn sends and receives ZeroMQ XML messages to a second backend server (typically C++). simpleui-server translates the received .xml into .json responses and sends them back to the front end.

Basic setup

• Node 18+
• NPM
• Docker

Development installation

• Clone the repo git clone https://github.com/greg-ses/simpleui simpleui && cd simpleui
• Build the development docker container docker build -t sui-dev-image -f develop_docker/Dockerfile .
• start the dev enviroment bash run-dev-env.bash
  • This might take a while since it will download the node_modules for base_app and simpleui-server

Production installation

When running SimpleUI in production, the docker container requires some CLI arguments.

docker run simpleui-image YOUR_APP_NAME zmqHostname=YOUR_ZMQ_HOSTNAME

• YOUR_APP_NAME: The name of your SimpleUI instance
• zmqHostname=: The hostname of your ZMQ REPLY sockets

Testing

• Start the dev enviroment and enter the docker container
• For frontend unit testing, run ng test in the base_app folder
• For backend unit testing, run npm run test in the simpleui-server folder
• E2E testing is coming soon

Linting

• Start the dev enviroment and enter the docker container
• For frontend linting, run ng lint in the base_app folder
• For backend linting, run npm run lint in the simpleui-server folder

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Please make sure to update tests as appropriate.

Credits

Project started by James Scarsdale and Greg Morehead. Karen Cummings created much of the initial scaffolding when Angular 2 was in constant flux. Tom Alexander has made very significant architectural contributions to the product. Docker environment by Nick Tosta. Maintained By Zack Beucler

License

MIT