Get pet panda in your terminal 🐼

• Interactive Terminal UI
• Create and choose actions on pets
• Concurrent state changes reflected to UI

• Python (CLI)
• Node.js (Microservices)
• Kafka (Message streams)
• Redis (Cache database)

1. /client
   • Contains Terminal UI application
2. /services
   • Contains 3 backend services and a dependency (libs) directory

Event-driven microservices with real-time state synchronization. See ARCHITECTURE.md for detailed design decisions and data flow.

Frist, clone the repo:

git clone https://github.com/joanne5548/binary-bamboo.git

Prerequisite: Docker Desktop is installed and running.

First, run Docker container:

cd services
docker compose up -d

And install dependencies & run microservices:

npm i && npm run dev

[!Note] Servers might not connect to Kafka on first try. If error message "This server does not host this topic-partition" is observed, terminate current process, and re-try the above command.

Go back to root directory. Set up a virtual environment using either:

1. Conda (Recommended)

cd client
conda env create -f environment.yml
conda activate bamboo

2. Pip

cd client
# Activate virtual environment
pip install -r requirements.txt

And run the CLI:

python src/main.py

Note that setting up environment variables is not a requirement for this application.

Placed in /client directory.

1. SERVER_DOMAIN: Server domain. Default: localhost
2. PORT: Port # to send API requests. Default: 8080

Placed in /server/api directory.

1. SERVER_DOMAIN: Server domain. Default: localhost
2. PORT: Port # to send API requests. Default: 8080

Joanne Kim
You can reach me at: [email protected]
Visit my website! | LinkedIn