readmes

Author: Connoropolous

README.md

@@ -1,10 +1,45 @@
-## How to build an Electron app using create-react-app. No webpack configuration or “ejecting” necessary.
+## Rapid Sensemaking Framework UI
 
-Code repo for post on [freeCodeCamp](https://medium.freecodecamp.com/building-an-electron-application-with-create-react-app-97945861647c#.ze6c9qin1).
+Design and run rapid sensemaking processes!
 
-https://medium.freecodecamp.com/building-an-electron-application-with-create-react-app-97945861647c#.ze6c9qin1
+Connects to a 'noflo runtime' in order to execute a configured flow-based programming graph.
 
-Thanks to [marbemac](https://github.com/marbemac) for submitting a pull request that captures logging output. It can be found in [logging-capture](https://github.com/csepulv/electron-with-create-react-app/tree/logging-capture)
+This repo can be extended to allow different noflo graphs representing various rsf type flows. 
 
-Thanks to [vicentedealencar](https://github.com/vicentedealencar) for an example of using [electron-builder](https://github.com/electron-userland/electron-builder) for packaging. Details are [here](https://github.com/vicentedealencar/electron-with-create-react-app/commit/f1729381d588e65ac140ce5a08cc6277babd9641).
+These flows can be designed and run on https://app.flowhub.io. Download the graph JSON files, and put them in this repo in the `graphs` folder. Then, create a JSON template for it and put in the `templates` folder.
 
+
+Setup for connection with a participant register http server:
+
+`.env` example:
+```
+REGISTER_HOST=127.0.0.1
+REGISTER_PORT=3002
+REGISTER_WS_PROTOCOL=ws
+REGISTER_HTTP_PROTOCOL=http
+```
+
+Setup for connection with a rsf noflo server runtime:
+
+`.env` example:
+```
+RUNTIME_ADDRESS=ws://127.0.0.1:3569
+RUNTIME_SECRET=1lkj3134jn
+```
+
+
+For development:
+
+run `npm start`
+
+To build for production:
+```
+npm run tsbuild-electron
+npm run tsbuild-react
+npm run build
+```
+
+To test this build, run
+```
+npm run electron
+```