Coding and design guidelines
- Server
- 0. Folder structure
- 1. Naming convention
- 2. Single responsibility principle
- 3. Small methods
- 4. Duplication
- 5. Variables and methods declaration
- 6. Structure your code correctly
- 7. Database
- 8. Comments
- 9. Utility
- 10. Auto configuration
- 11. Keep your
@RestController
’s clean and focused - 12. Use DTOs for data transfer
- 13. Dependency injection
- 14. Keep it simple and stupid
- 15. File handling
- 16. General best practices
- 17. Avoid service dependencies
- 18. Proper annotation of SQL query parameters
- 19. SQL statement formatting
- 20. Avoid the usage of Sub-queries
- 21. Criteria Builder
- 22. REST endpoint best practices for authorization
- 23. Assert using the most specific overload method
- 24. General Testing Tips
- 25. Counting database query calls within tests
- 26. Avoid using @MockBean
- Client
- 0. General
- 1. Names
- 2. Components
- 3. Types
- 4.
null
andundefined
- 5. General Assumptions
- 6. Comments
- 7. Strings
- 8. Buttons and Links
- 9. Icons with Text
- 10. Labels
- 11. Code Style
- 12. Preventing Memory Leaks
- 13. Defining Routes and Breadcrumbs
- 14. Strict Template Check
- 15. Chart Instantiation
- 16. Responsive Layout
- 17. WebSocket Subscriptions
- Client Tests
- Client Theming
- Database Relationships
- Criteria Builder
- Inclusive, Diversity-Sensitive, and Appreciative Language