1. Import

This commit is contained in:
2026-01-22 19:40:24 +01:00
parent bf050e8cb3
commit e46f12807a
22 changed files with 2517 additions and 66 deletions

View File

@@ -1,83 +1,61 @@
# AI TOOL GUIDANCE
# CLAUDE.md
This file provides guidance when working with code in this repository.
This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
## Technology Stack
This is a Vaadin application built with:
- Java
- Spring Boot
- Spring Data JPA with H2 database
- Maven build system
- **Java 21**
- **Vaadin 25.0.3** (server-side Java UI framework with Lumo theme)
- **Spring Boot 4.0.1**
- **Maven build system**
## Development Commands
### Running the Application
```bash
./mvnw # Start in development mode (default goal: spring-boot:run)
./mvnw # Start in development mode (default goal)
./mvnw spring-boot:run # Explicit development mode
```
The application will be available at http://localhost:8080
### Building for Production
```bash
./mvnw -Pproduction package # Build production JAR
docker build -t my-application:latest . # Build Docker image
```
### Testing
```bash
./mvnw test # Run all tests
./mvnw test -Dtest=TaskServiceTest # Run a single test class
./mvnw test -Dtest=TaskServiceTest#tasks_are_stored_in_the_database_with_the_current_timestamp # Run a single test method
./mvnw test -Dtest=MyTest # Run a single test class
./mvnw test -Dtest=MyTest#method # Run a single test method
./mvnw -Pproduction package # Build production JAR
```
## Architecture
Application runs at http://localhost:8080 (auto-launches browser in dev mode).
This project follows a **feature-based package structure** rather than traditional layered architecture. Code is organized by functional units (features), not by technical layers.
## Project Structure
### Package Structure
```
de.assecutor.aimailassistant/
├── Application.java # Entry point with @SpringBootApplication
└── [feature packages] # Add feature packages here
```
- **`de.assecutor.aimailassistant.base`**: Reusable components and base classes for all features
- `base.ui.MainLayout`: AppLayout with drawer navigation using SideNav, automatically populated from @Menu annotations
- `base.ui.component.ViewToolbar`: Reusable toolbar component for views
This project uses **feature-based packaging**: each feature is self-contained with its own entities, repositories, services, and UI views.
- **`de.assecutor.aimailassistant.examplefeature`**: Example feature demonstrating the structure
- `Task.java`: JPA entity with validation
- `TaskRepository.java`: Spring Data JPA repository
- `TaskService.java`: Service layer with @Transactional methods
- `ui.TaskListView.java`: Vaadin Flow view component (server-side UI)
- `TaskServiceTest.java`: Integration test using @SpringBootTest
## Architecture Guidelines
- **`Application.java`**: Main entry point, annotated with @SpringBootApplication and @Theme("default")
### Adding Features
### Key Architecture Patterns
Create new packages under `de.assecutor.aimailassistant` (e.g., `de.assecutor.aimailassistant.mail`). Each feature package should contain:
- JPA entities
- Spring Data repositories
- Service classes with `@Transactional`
- Vaadin UI views
1. **Feature Packages**: Each feature is self-contained with its own UI, business logic, data access, and tests
2. **Navigation**: Views use `@Route` and `@Menu` annotations. MainLayout automatically builds navigation from menu entries
3. **Service Layer**: Use `@Transactional` for write operations and `@Transactional(readOnly = true)` for read operations
4. **Validation**: Domain validation in entity setters (see Task.setDescription)
5. **Dependency Injection**: Constructor injection throughout (no @Autowired on fields)
### Vaadin Patterns
## Adding New Features
- **Server-side rendering**: UI components are Java classes
- **Routing**: Use `@Route("path")` annotation on view classes
- **Navigation**: Use `@Menu` annotation to add views to automatic navigation
- **Lazy loading**: Use `VaadinSpringDataHelpers.toSpringPageRequest(query)` for Grid pagination
- **Styling**: Custom styles in `src/main/resources/META-INF/resources/styles.css`
When creating a new feature:
1. Create a new package under `de.assecutor.aimailassistant` (e.g., `de.assecutor.aimailassistant.myfeature`)
2. Include: Entity, Repository, Service, and UI view classes
3. Use the `examplefeature` package as a reference
4. Once your features are complete, **delete the `examplefeature` package entirely**
### Spring Patterns
## Vaadin-Specific Notes
- **Server-side rendering**: UI components are Java classes extending Vaadin components
- **Grid lazy loading**: Use `VaadinSpringDataHelpers.toSpringPageRequest(query)` for pagination
- **Themes**: Located in `src/main/frontend/themes/default/`, based on Lumo theme
- **Routing**: `@Route("")` for root path, `@Route("path")` for specific paths
- **Menu**: `@Menu` annotation controls navigation items (order, icon, title)
- Constructor injection (no `@Autowired` on fields)
- `@Transactional` for write operations
- `@Transactional(readOnly = true)` for read operations
## Database
- H2 in-memory database for development
- JPA entities use `@GeneratedValue(strategy = GenerationType.SEQUENCE)`
- Entity equality based on ID (see Task.equals/hashCode pattern)
No database configured yet. To add persistence, include Spring Data JPA and a database driver in pom.xml.