Optimizing Elixir Project Structure for Scalability

Goulven CLECH's article focuses on the challenges and methodologies involved in structuring an Elixir/Phoenix project to accommodate growth and maintain clarity. The author draws from their experiences at a real estate startup that encountered issues due to an evolving codebase and varying developer input leading to inconsistent directory structures. Starting with an examination of the conventional directory structures provided by Elixir and Phoenix documentation, the author critically assesses their project's existing structure and outlines key considerations for reorganizing their codebase. They present three distinct approaches attempted by their team—nested, flat, and a mishmash of both—and their associated pros and cons. Finally, the article introduces their final proposal, aiming for a balance between these approaches that adheres to principles of documentation and clarity. The importance of involving the entire team in the decision-making process using GitHub Issues is emphasized, demonstrating how collective discussion can lead to a well-documented and supported redesign. The author reflects on the lessons learned, the value of active team participation, and proposes improvements for future decision-making processes.