Skip to content

Commit 815e180

Browse files
authored
Update README.md
1 parent f6b20dd commit 815e180

File tree

1 file changed

+13
-22
lines changed

1 file changed

+13
-22
lines changed

README.md

+13-22
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
11
# PubSub Emulator UI
2+
This application is meant to assist in local development of software related to Google Pub/Sub. This will allow one to view and create pubsub messages as well as create topics + pull subscriptions on a locally hosted instance of the pubsub emulator
23

34
## Quickstart
45

5-
1. download the docker-compose.yml
6-
2. Spin up the emulator + ui
7-
```
8-
docker-compose up
9-
```
10-
3. You will have a pubsub emulator running with the project name: `test-project`
11-
- feel free to modify the topic + subscriptions in the docker compose for your needs
12-
4. Run docker ps to list the running containers so that you can see the ports you need to connect to
13-
- by default emulator on 8681, ui on 7200 (you can change this in docker-compose)
14-
15-
16-
## Introduction
17-
This application is meant to assist in local development of software related to Google Pub/Sub.
18-
19-
### Screenshots
20-
[![Screenshot-from-2022-05-15-15-47-40.png](https://i.postimg.cc/Fzy9cv7Q/Screenshot-from-2022-05-15-15-47-40.png)](https://postimg.cc/wRB88SXW)
21-
22-
[![Screenshot-from-2022-05-15-15-48-34.png](https://i.postimg.cc/2jhjgQTX/Screenshot-from-2022-05-15-15-48-34.png)](https://postimg.cc/CdMVqf3j)
6+
1. Utilize docker to run the pubsub emulator ui
7+
```
8+
docker run -p 4200:80 ghcr.io/neoscript/pubsub-emulator-ui:latest
9+
```
10+
- Note if you want to also spin up an instance of the pubsub emulator take a look at the [`docker-compose.yml`](https://github.com/NeoScript/pubsub-emulator-ui/blob/main/docker-compose.yml) file in this project's root 😉
11+
2. Add the project you would like to track
12+
![Screenshot from 2024-02-09 09-15-28](https://github.com/NeoScript/pubsub-emulator-ui/assets/3144162/7eab63e9-361e-45f4-9d29-714e6c286bb3)
13+
3. Now add topics/subscribers and send/receive messages as you would like 😄
14+
![Screenshot from 2024-02-09 09-16-26](https://github.com/NeoScript/pubsub-emulator-ui/assets/3144162/a5b6523a-30e8-4cdd-a4e6-620c58152067)
2315

2416
### Motivations
2517
- The current Google Pub/Sub emulator does not have any visual tooling
@@ -34,7 +26,7 @@ This application is meant to assist in local development of software related to
3426
git clone https://github.com/NeoScript/pubsub-ui.git
3527
```
3628
2. Then open the folder with VSCode
37-
- VSCode is NOT required, but I've got some .devcontainers setup that may be helpful
29+
- vscode is not required, but I've got a .devcontainers setup that may be helpful
3830
```
3931
cd pubsub-ui
4032
code .
@@ -43,8 +35,7 @@ This application is meant to assist in local development of software related to
4335
- To learn more about devcontainers check out [this link](https://code.visualstudio.com/docs/remote/containers)
4436
4. Spin up the supporting docker-compose file
4537
- note: we are currently spinning up [this very helpful wrapper](https://github.com/marcelcorso/gcloud-pubsub-emulator) around the emulator.
46-
- additionally I have the [gcp-pubsub-emulator-ui](https://github.com/echocode-io/gcp-pubsub-emulator-ui) image spinning up as well just so I can use it as a reference for some functionality
47-
- at some point we may try and transition to just spinning up the gcloud sdk itself
38+
- at some point we may try and transition to just spinning up the gcloud sdk itself (if anyone knows an easy way, tell me!)
4839
4940
5. Start serving the angular webapp
5041
```
@@ -57,4 +48,4 @@ This application is meant to assist in local development of software related to
5748
### Additional Info
5849
LICENSE: MIT
5950
60-
Feel free to do whatever you want, all improvements and suggestions are welcome!
51+
All improvements and suggestions are welcome!

0 commit comments

Comments
 (0)