Skip to content

Commit

Permalink
docs: add info that examples have to be run with gradle (#653)
Browse files Browse the repository at this point in the history
  • Loading branch information
timonback authored Mar 22, 2024
1 parent 1d40b8a commit a7ea1ee
Show file tree
Hide file tree
Showing 6 changed files with 38 additions and 1 deletion.
8 changes: 7 additions & 1 deletion springwolf-examples/springwolf-amqp-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,10 @@
1. Copy the `docker-compose.yml` file to your machine.
2. Run `$ docker-compose up`.
3. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.
4. RabbitMQ Management: `http://localhost:15672` using `guest:guest` as login
4. RabbitMQ Management: `http://localhost:15672` using `guest:guest` as login

### Run with gradle
Note: You need to execute the gradle `bootRun` task since the IntelliJ spring application will not include springwolf-ui correctly.

1. Start the application: `$ cd springwolf-core && ./gradlew build -p springwolf-examples/springwolf-amqp-example bootRun`.
2. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.
2 changes: 2 additions & 0 deletions springwolf-examples/springwolf-cloud-stream-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@
3. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.

### Run with gradle
Note: You need to execute the gradle `bootRun` task since the IntelliJ spring application will not include springwolf-ui correctly.

1. Verify zookeeper and kafka are running.
2. Define an environment variable with the bootstrap server details: `$ export BOOTSTRAP_SERVER=localhost:9092`.
3. Clone this repository: `$ git clone https://github.com/springwolf/springwolf-core.git`.
Expand Down
9 changes: 9 additions & 0 deletions springwolf-examples/springwolf-jms-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,12 @@
1. Copy the `docker-compose.yml` file to your machine.
2. Run `$ docker-compose up`.
3. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.

### Run with gradle
Note: You need to execute the gradle `bootRun` task since the IntelliJ spring application will not include springwolf-ui correctly.

1. Verify JMS is running.
2. Define an environment variable with the bootstrap server details: `$ export BOOTSTRAP_SERVER=tcp://activemq:61616`.
3. Clone this repository: `$ git clone https://github.com/springwolf/springwolf-core.git`.
4. Start the application: `$ cd springwolf-core && ./gradlew build -p springwolf-examples/springwolf-jms-example bootRun`.
5. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.
2 changes: 2 additions & 0 deletions springwolf-examples/springwolf-kafka-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
Note: kafka-schema-registry (avro) and akhq (a kafka ui) are not started by default

### Run with gradle
Note: You need to execute the gradle `bootRun` task since the IntelliJ spring application will not include springwolf-ui correctly.

1. Verify kafka (and kafka-schema-registry if you want to test avro as well) are running.
2. If your kafka is not configured to automatically add topics, manually add a topic named `example-topic`.
3. Define an environment variable with the bootstrap server details: `$ export BOOTSTRAP_SERVER=localhost:9092`.
Expand Down
9 changes: 9 additions & 0 deletions springwolf-examples/springwolf-sns-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,12 @@
1. Copy the `docker-compose.yml` file to your machine.
2. Run `$ docker-compose up`.
3. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.

### Run with gradle
Note: You need to execute the gradle `bootRun` task since the IntelliJ spring application will not include springwolf-ui correctly.

1. Verify SNS is running.
2. Define an environment variable with the bootstrap server details: `$ export SPRING_CLOUD_AWS_ENDPOINT=http://localstack:4566`.
3. Clone this repository: `$ git clone https://github.com/springwolf/springwolf-core.git`.
4. Start the application: `$ cd springwolf-core && ./gradlew build -p springwolf-examples/springwolf-sns-example bootRun`.
5. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.
9 changes: 9 additions & 0 deletions springwolf-examples/springwolf-sqs-example/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,12 @@
1. Copy the `docker-compose.yml` file to your machine.
2. Run `$ docker-compose up`.
3. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.

### Run with gradle
Note: You need to execute the gradle `bootRun` task since the IntelliJ spring application will not include springwolf-ui correctly.

1. Verify SQS is running.
2. Define an environment variable with the bootstrap server details: `$ export SPRING_CLOUD_AWS_ENDPOINT=http://localstack:4566`.
3. Clone this repository: `$ git clone https://github.com/springwolf/springwolf-core.git`.
4. Start the application: `$ cd springwolf-core && ./gradlew build -p springwolf-examples/springwolf-sqs-example bootRun`.
5. Visit `localhost:8080/springwolf/asyncapi-ui.html` or try the API: `$ curl localhost:8080/springwolf/docs`.

0 comments on commit a7ea1ee

Please sign in to comment.