CoolBeans Web App

Current

Compose setup

Example .env networking config:

PGHOST=timescaledb
POSTGRES_PORT=1156
GRAFANA_PORT=1155
ROS2_PORT=1154
FASTAPI_PORT=1153
REACT_PORT=1152

Ensure .env is placed in ./docker. If you want to better understand what is going on, check the following places:

• the docker-compose.yaml ${} interpolations,
• our TimescaleDB, Grafana docs (README.md files),
• the GH Actions CI pipeline .yaml.

Ensure FASTAPI_PORT in docker/.env matches its counterpart in frontend/.env. Ensure PG_HOST in backend/external/.env matches its counterpart in docker/.env. Ensure ROS2_PORT in backend/external/.env matches its counterpart in docker/.env Ensure ROS2_HOSTNAME in backend/external/.env matches its counterpart in docker/.env and service name in docker/docker-compose.yaml.

Checkout the external repo: git submodule add git@github.com:NPKBlackBean/devel.git submodules/devel (Note: the above may or may not work, possibly commiting a submodule into our repo might take care of this - I wrote this while manually setting up on RPi)

(Note: this branch is what worked) cd submodules/devel && git checkout rostest-initial

# if you're running tmux and want to see logs
cd docker && docker compose up
# if you're running a single terminal
cd docker && docker compose up -d

Troubleshooting networking

To understand why the frontend fetches from http://fastapi:3000/backend_ip or why the backend connects to host='ros2', port=9090, or why in .env we have PGHOST=timescaledb, look to the Docker compose networking docs: "... Each container can now look up the service name web or db and get back the appropriate container's IP address. For example, web's application code could connect to the URL postgres://db:5432 and start using the Postgres database.."

Synthetic data generation

The reasoning used when creating the functions for synthetic data generation can be found within the project report. To generate a ~50 MB database containing synthetic data for 36 plants, run:

cd backend
uv run python app/synthetic_data/synthetic_data.py

Legacy

Run the app

1. Execute:

cd frontend
bun run dev --host 0.0.0.0

cd ../backend
uv run fastapi dev app/main.py # or just fastapi dev app/main.py

Add .env file to database/docker and set up environmental variables required by the PostgreSQL database and Grafana containers (see: database/README.md)

cd ../database/docker # for further instructions on working with db set up go to database/README.md
sudo docker compose up -d

2. Open the app at http://localhost:3000 (frontend dev server) and Grafana at http://localhost:3001 (login with GRAFANA_USER/GRAFANA_PASSWORD from .env).

Development setup

Install the mypy plugin for PyCharm to have static typing when working with the backend.

We use uv for package management in Python. In short, use the following command when installing packages:

# example
uv add mypy

After installing uv on your system, navigate to backend. Execute

uv init .

Make sure to configure the Python interpreter to be set to the one from backend/.venv in PyCharm. What this means is: go to the bottom right corner of your IDE, and select an existing uv interpreter. It will point to your system uv install, but you have to specify our backend/.venv as the Python interpreter source.

Now execute the following to install dependencies:

uv sync