Skip to content

Navigating this codebase

Andrew Howe-Ely edited this page Dec 4, 2023 · 4 revisions

Unless you're doing a very trivial change to this application, I really recommend reading everything in this wiki to gain a holistic understanding of how manage-frontend works.

Just a few thoughts for navigating this repository...

  • efforts have been made to have detailed PR descriptions, so it's recommended to use the brilliant 'blame' feature of GitHub to trace back through the commits that led up to the lines of code you might be changing, then clicking the PR number, e.g. #430... image ...to get to the [hopefully] juicy and insightful PR description.

  • using an IDE is strongly advised, as this application leans on the type-system a fair bit and clicking through to type definitions as well as clicking back and forth between function declarations and their usages is super useful

  • in terms of where to begin, usually the best place to start will be client/components/mma/MMAPage.tsx (see wiki/Client-side-routing) as this is where all the top level client-side routes are defined, often created in loops over Product Types as well as the nesting that represents the hierarchal 'Flows', from there you can fan-out/drill-down to pretty much everything

Clone this wiki locally