setup README and requirements

This commit is contained in:
2025-11-07 17:15:40 -05:00
parent bdfd9d7e05
commit 2efbedb76d
2 changed files with 25 additions and 0 deletions

24
README.md Normal file
View File

@@ -0,0 +1,24 @@
# Kafka Example
This is a very simple application to demonstrate how to set up a Kafka instance, create a consumer and a producer, and send and receive messages.
## Setup
1) Create a virtual environment
2) Install required libraries
```zsh
pip3 install -r requirements.txt
```
3) Run Kafka using Docker Compose
```zsh
docker compose up
```
4) Run tracker.py
```zsh
python3 src/tracker.py
```
5) Run producer.py
```zsh
python3 src/producer.py
```
6) Confirm messages in terminal