HomeSecurity/documentation.md

819 B

📖 Documentation

Project Structure

The project follows a standard Spring Boot application structure:

  • src/main/java/com/example/HomeSecurity: Root package.
    • Controllers: Contains Spring MVC controllers for handling web requests and WebSocket endpoints.
    • Services: Houses business logic, such as processing sensor data and managing security states.
    • DTOs: Data Transfer Objects used to shape data for the views and API responses.
    • Components: Contains hardware integration components, like the ArduinoListener.
    • Models: JPA Entities representing database tables (e.g., Sensor).
  • src/main/resources:
    • static: For static assets like CSS, JavaScript, and images.
    • templates: Contains Thymeleaf HTML templates.
    • application.properties: For application configuration.