Skip to content

Latest commit

 

History

History

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 

README.md

Software

This directory contains the EC2-side software stack and software-facing support material.

What Matters Most

If you are evaluating the project as a technical portfolio, this directory is where the networked system behaviour becomes visible:

  • the cloud runtime ingests and reconstructs drawings
  • the database stores finalized history and leaderboard state
  • the live console exposes the system to an operator
  • the tools provide repeatable checks and demo paths

If You Open One File First

For most newcomers, start with:

Then move to the protocol docs to understand how the node and cloud service talk to each other.

Main Areas

  • cloud/ the FastAPI-based Wand Brain service, database layer, and live console UI.
  • protocol/ documented software contracts, especially the UDP point-stream and HTTP APIs.
  • tools/ smoke tests, synthetic senders, and operator/demo helpers.

Start Here

Newcomer Route

If you want the shortest path through the software side, read:

  1. cloud/README.md
  2. protocol/protocol/pynq-udp-flow.md
  3. protocol/protocol/brain-web_api.md
  4. cloud/report/backend_system_report.md
  5. ../docs/demo/final_runbook.md

This sequence takes you from the live data path to the served APIs and then to the backend/database/frontend architecture, with a runnable final-system path at the end.