How morenaperalta/fixly works
Project type and purpose
• This is a backend REST API (no UI code) built with Spring Boot to manage work orders, users, comments, and attachments. It implements JWT-based security, role-based access control, and integrates with MySQL and Cloudinary for persistence and file storage.
File structure
• Top-level files:
• Dockerfile, docker-compose.yml → containerization
• pom.xml, mvnw → Maven build
• README.md → project overview & architecture
• .github/workflows/ci.yml → GitHub Actions CI
• src/main/java/com/femcoders/fixly:
• FixlyApplication.java → Spring Boot entry point
• Packages:
– auth, user, workorder, comment, attachment, status_history → domain modules
– shared/config → SecurityConfig, SwaggerConfig, CloudinaryConfig
– shared/security → JWT filter, entry points, user details
– shared/exception → global exception handler
• src/main/resources:
• application.yml & application-docker.yml → environment configs
• data.sql, banner.txt → seed data & startup banner
• Tests: organized mirroring main code structure (unit + integration).
README for additional insights
• Describes multi-role user management and full work order lifecycle
• Lists main entities: User, WorkOrder, WorkOrderAssignment, Comment, Attachment
• Mentions external dependencies: MySQL, Cloudinary, Swagger, GitHub Actions CI/CD