Skip to content

Commit

Permalink
finished README for testing without docker and adapted script paths
Browse files Browse the repository at this point in the history
  • Loading branch information
Peter Schueller committed Nov 20, 2020
1 parent 687975e commit c619138
Show file tree
Hide file tree
Showing 8 changed files with 23 additions and 26 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,19 @@ You can test each component (GUI, ASP Solver, Sudoku Evaluator) independent from
This section shows how to run each component and test it.
The next section describes how to run the whole pipeline using an orchestrator.

## Running and Testing without docker

The whole pipeline can run without docker.
But you need to install all required packages.

* See Section Prerequisites, `conda` might be your friend.
* See Section Starting and Testing.
* Each component has a `run-<component>.sh` script that needs to be run in the respective directory.
* Components must be started before the orchestrator is started, but the order of components does not matter.
* You will end up with 4 terminals (3 components + orchestrator).

Then, in a new browser window open http://localhost:8000/ and click on the Sudoku Grid and observe the messages in the top window.

## Individual start of each docker container and testing

* GUI
Expand Down
3 changes: 3 additions & 0 deletions aspsolver/run-aspsolver.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

python3 server.py

3 changes: 3 additions & 0 deletions evaluator/run-evaluator.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

python3 server.py

2 changes: 1 addition & 1 deletion gui/run-gui.sh
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#!/bin/echo must be run in bash with .

# run without --reload so that we can kill it cleanly
uvicorn server:app --host 0.0.0.0 --port 8000 --log-level debug

3 changes: 3 additions & 0 deletions orchestrator/run-orchestrator.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

python3 orchestrator.py

8 changes: 0 additions & 8 deletions run-aspsolver.sh

This file was deleted.

8 changes: 0 additions & 8 deletions run-evaluator.sh

This file was deleted.

9 changes: 0 additions & 9 deletions run-orchestrator.sh

This file was deleted.

0 comments on commit c619138

Please sign in to comment.