How jalizadeh/todocial works
Project Type and Purpose
• This is a full-stack Java web application (“ToDocial”) built with Spring Boot, using JSP for the UI and a relational database for persistence.
• It provides social-todo management: user registration/login, todo CRUD, sharing, gym plans, charts, an admin dashboard, file uploads, plus CI/tests.
File Structure
• Top-level:
• pom.xml, Maven wrapper (.mvn + mvnw) → Java/Spring Boot build.
• Jenkinsfile → CI/CD pipeline.
• src/main/java → application code follows typical layered (controller, service, repository, model) structure.
• src/main/webapp/WEB-INF/jsp + resources → JSP views, CSS/JS, static assets (Highcharts, Bootstrap, jQuery, Font-Awesome).
• src/main/resources → Spring configuration (application.yml/properties), I18N messages, gym.properties.
• src/test → unit tests (JUnit), integration/api tests, Selenium UI tests, Cucumber features.
• upload-dir → runtime file storage for diaries, gyms, user uploads.
• .db files → local SQLite or H2 files for quick persistence in different modes.
• Architectural patterns:
• MVC for web (Controller → JSP view + static).
• Service-Repository for business logic/data access.
• Spring Security for authentication/authorization.
• Event-listener pattern for registration/email/password-reset.
• StorageService abstraction for file uploads.
• Multi-module testing: unit, integration, end-to-end.
README for Insights
• Tech stack: Spring Boot, JSP, Maven.
• Features: user-centric flows, admin dashboard, charts (Highcharts).
• Test strategy: JUnit (REST API), Selenium (UI), CI with Sonar.
Detailed Capture of Architectural Elements
• Major controllers (UserAccount, TodoController, GymController, AdminDashboardController).
• How REST API controllers (GymApi, TodoApi, UserApi) differ from MVC controllers.
• Configuration classes (SecurityConfig, WebMvcConfig, AppLocaleResolver).
• Test suites separately or note under CI pipeline.