Skip to content

Latest commit

 

History

History
26 lines (13 loc) · 2.06 KB

README.md

File metadata and controls

26 lines (13 loc) · 2.06 KB

tinybox

Monorepo for our Tinybox's data platform and web app.

Melbourne - Annual Average Traffic Volume

Melbourne - Annual Average Traffic Volume

CBD - Bike Paths and Docks

CBD - Bike Paths and Docks

Victoria - Median Population Age by Local Government Area

Victoria - Median Population Age by Local Government Area

Victoria - Crime Rate by Local Government Area

Victoria - Crime Rate by Local Government Area

The ARCHITECTURE.md file will contain a high-level overview of the project architecture, including diagrams written in the D2 diagramming DSL, using the C4 paradigm (https://c4model.com/) for simplicty and clarity.

On the other hand, comprehensive development documentation will live under the docs folder. If you need to add documentation while developing, please do so there under the relevant application subfolder.

This repo is structured using src-layout: local library code is in src, and the main applications are in tools. Accordingly, if you need to write an importable Python module, please do so in a subfolder under src and import it into the relevant application in tools. This will allow us to keep the main applications as clean as possible. When invoked, Hatch automatically ensures that all library code under src is installed in development mode, rendering it callable from anywhere else in the project. There is no need to do so manually.