Oasis Accelerator Series

Build Session 3 - Structuring a Maintainable Codebase

Agenda

Designing for Maintainability.

Structuring the Codebase.

Maintaining the Codebase.

Designing for Maintainability

.

What is Maintainable Code?

• Easy to understand
• Easy to modify
• Easy to test
• Easy to debug
• Consistent and predictable

.

Separation of Responsibilities

• Each component has one clear role
• Business logic stays separate
• UI handles presentation
• Database code handles persistence
• Smaller components are easier to change

.

Keep Code Loosely Coupled

• Minimize dependencies
• Avoid circular dependencies
• Limit shared state
• Changes stay localized
• Use clear interfaces between components

.

Avoid Overengineering!

• Start with simple solutions
• Don't abstract too early
• Avoid unnecessary layers
• Add complexity when needed

Structuring the Codebase

.

Organize Code by Feature

• Keep related code together
• Make code easy to find
• Reduce unrelated dependencies
• Scale structure with the application

.

Use Clear Layers

• Controller → handles requests
• Service → business logic
• Repository → data access
• Each layer has a clear purpose

Maintaining the Codebase

.

Write Testable Code

• Keep functions small
• Use clear inputs and outputs
• Isolate external services
• Avoid hidden state
• Test behavior, not implementation

.

Recognize Code Smells

• Large functions
• God classes (single class has too many responsibilities)
• Duplicated logic
• Deep nesting
• Circular dependencies
• Unclear naming

.

Refactoring

• Remove duplication
• Simplify complex logic
• Break up large components
• Improve unclear abstractions
• Don't let technical debt accumulate

Questions?

Project Leads, please now create and assign a ticket

Let’s put this into practice 🚀

Build time 🛠️