This directory is the maintained reference for building and extending the EuroPython Companion app. It focuses on the code that exists in this repo and the decisions already made; release and deployment guidance is out of scope here.
docs/getting-started.md- setup, run commands, and common startup failuresdocs/architecture.md- runtime structure, data flow, navigation, and file-by-file walkthroughdocs/project-structure.md- why eachsrc/folder exists and its boundariesdocs/development-workflow.md- adding screens/components and shared logic safelydocs/configuration.md- Expo/app config and static (non-environment-variable) configurationdocs/navigation.md- route structure, typing, and concrete navigation examplesdocs/data-and-state.md- data sources, stores, derived state, and side effectsdocs/testing.md- current test posture and contributor expectationsdocs/future-work.md- known limitations and safe areas to extend
- Feature development: docs/getting-started.md, then docs/project-structure.md, docs/development-workflow.md, and docs/navigation.md.
- Bugfixes: docs/getting-started.md, then docs/data-and-state.md for data paths and docs/testing.md for validation scope.
- Refactors: docs/architecture.md, then docs/project-structure.md and docs/configuration.md to avoid breaking assumptions.
This set was rewritten from a full read of the current source (not from the previous docs, which had drifted). When you change code that these docs describe, update the relevant doc in the same change — don't let it drift again.