How rightmove/code-challenge-devex works
Project type and purpose
• This is a Java-based Spring Boot web service (backend only) that provides residential property information over a REST API.
• It’s organized as a multi-module Gradle project with two subprojects:
• “data” holds your DAO layer, entities and data population logic
• “web” is the Spring Boot application exposing HTTP endpoints
File structure
• Top-level files: gradle wrapper, Dockerfile, settings.gradle, build scripts.
• “data” module
• src/main/java/com/rightmove/property/data → PropertyEntity, PropertyType, PropertyDao & its implementation, DataPopulator
• src/test → unit tests for DAO
• “web” module
• Application.java (Spring Boot entry point)
• PropertyController, PropertyResult DTO
• application.properties
• datasetup tests in web/src/test
• No separate service layer—controllers talk directly to DAOs from the data module.
Key insights from README
• Java 21 (or newer), Gradle wrapper, Docker ready
• Spring Boot 3.4.3, JUnit 5 for tests
• Typical lifecycle: DataPopulator loads initial data into the chosen datastore at startup, controllers handle HTTP GET/POST, DAOs interact with the database.
Main components and their relationships
a. Components
• Client (e.g. browser or other service)
• Spring Boot Application (“web” module) including:
• PropertyController (REST API layer)
• DataPopulator (startup data loader)
• “data” module beans:
• PropertyDao (interface)
• PropertyDaoImpl (JPA or JDBC interactions)
• PropertyEntity & PropertyType (domain model)
• Database (relational or in-memory store configured in application.properties)
• Build & deployment: Gradle → Docker image → container
b. Interactions
• Client → HTTP request → PropertyController
• Controller calls PropertyDaoImpl → SQL/ORM → Database
• On startup, DataPopulator runs → writes initial records to Database
c. Architectural patterns & principles
• Modular monolith (multi-module Gradle project)
• Layered: Controller → DAO → Entity → Database
• Dependency injection (Spring-managed beans across modules)
• Single responsibility: data module cannot start HTTP server; web module depends on data module
d. Key technologies
• Spring Boot (REST, DI)
• Java 21
• Gradle multi-project build
• JUnit 5
• Docker