Skip to content

Commit a5ced29

Browse files
committed
Demo mode starts automatically
1 parent 06750ae commit a5ced29

File tree

2 files changed

+24
-6
lines changed

2 files changed

+24
-6
lines changed

Makefile

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,10 @@ repo-clean:
4545

4646
.PHONY: demo run-demo
4747
demo: install up
48-
${MAKE} -j4 run-demo
48+
${MAKE} -j3 run-demo
4949

50-
.PHONY: run-demo run-query run-response run-ui start-ui
51-
run-demo: run-ui start-ui run-query run-response
50+
.PHONY: run-demo run-query run-response run-ui
51+
run-demo: run-ui run-query run-response
5252

5353
run-query:
5454
sleep 10
@@ -60,6 +60,3 @@ run-response:
6060

6161
run-ui:
6262
${MAKE} -C ui/
63-
64-
start-ui:
65-
${MAKE} -C ui-frontend/

README.adoc

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,27 @@ Spring Boot can find the code in the `zzz/` branches, and use it as a
138138
reference for their own projects. The code in these branches will not be
139139
actively maintained, but will remain available for reference.
140140

141+
== Demo Setup & Development
142+
143+
Prerequisites for development include a working Java 21+ environment, docker
144+
and docker-compose as well as node and npm for building the frontend UI.
145+
146+
To get a local development environment up and running, you can use the provided
147+
`docker-compose.yml` file to start a RabbitMQ container. This will allow you to
148+
test and develop Query/Response functionality locally.
149+
150+
We've also prepared a quick and easy way to build, install and start a demo
151+
setup of Query/Response locally. Just simply run:
152+
153+
```shell
154+
> make demo
155+
```
156+
157+
This will build the project, install the dependencies, and start a demo setup
158+
with a querying service and a responding service. As well a the UI for
159+
monitoring and exploring the system. The UI will be available at
160+
http://localhost:8080.
161+
141162
Happy coding!
142163

143164
---

0 commit comments

Comments
 (0)