Coding and design guidelines

Coding and design guidelines

• Performance
  • 1. Data Economy
  • 2. Large Scale Testing
  • 3. Paging
  • 4. Avoiding the N+1 Issue
  • 5. Optimal Use of Left Join Fetch
  • 6. General SQL Database Best Practices
• 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 Efficient Data Transfer
    • Purpose of DTOs
    • Guidelines for Implementing DTOs
    • Implications of Not Using DTOs
  • 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. Do NOT use Sub-queries
  • 21. Criteria Builder
  • 22. REST endpoint best practices for authorization
    • Implicit pre- and post-authorization annotations
    • Explicit authorization checks
  • 22. JSON serialization and deserialization
• Server Tests
  • 0. General testing tips
  • 1. Assert using the most specific overload method
  • 2. ArchUnit
  • 3. Counting database query calls within tests
  • 4. UtilServices and factories
  • 5. Test performance tips
  • 6. Avoid using @MockBean
  • 7. Parallel test execution
• Client
  • 0. General
  • 1. Names
  • 2. Components
  • 3. Types
  • 4. null and undefined
  • 5. General Assumptions
  • 6. Comments
  • 7. Strings
  • 8. Localization
  • 9. Buttons and Links
  • 10. Icons with Text
  • 11. Labels
  • 12. Code Style
  • 13. Preventing Memory Leaks
    • What are memory leaks?
    • What are common reasons for memory leaks?
    • What are ways to identify memory leaks?
  • 14. Defining Routes and Breadcrumbs
  • 15. Strict Template Check
    • Use ArtemisTranslatePipe instead of TranslatePipe
    • Use ArtemisTimeAgoPipe instead of TimeAgoPipe
  • 16. Chart Instantiation
  • 17. Responsive Layout
  • 18. WebSocket Subscriptions
  • 19. Styling
• Client Tests
• Client Theming
  • 0. Color Usage
  • 1. Theme-specific global styles
  • 2. Theme Service
• Database
  • 1. Retrieving and Building Objects
  • 2. Relationships
  • 3. Cascade Types
  • 4. Dynamic Fetching
  • Best Practices
  • Solutions for known issues
• Criteria Builder
  • 1. Requirements
  • 2. Generating the query
  • 3. Operations
  • 4. Joins
  • 5. Sub-Queries
  • 6. Examples
  • 7. Limitations
  • 8. Additional links
• Inclusive, Diversity-Sensitive, and Appreciative Language
  • Motivation
  • English language
  • German language
  • Sources and further material