ServiceChecklist.md

Service Checklist

1. Create Spring Boot application.
   1. Add Spring Boot Starter Web.
   2. Add Spring Boot Starter Data JPA.
   3. Add Spring Cloud Starter Netflix Eureka Client.
   4. Add net, util and test library dependencies and repositories.
2. Setup Spring Boot application.
   1. Replace application.properties with application.yml.
   2. Set application port.
   3. Set application name.
   4. Add resource filtering to pom.xml.
   5. Set application version.
   6. Configure Eureka client and H2 console for local development.
3. Setup GitHub CI.
   1. Add <distributionManagement> to pom.xml.
   2. Create workflow YML file.
4. Setup logging.
   1. Add @EnableOpenGameBackendUtils and @ConfigurationPropertiesScan.
   2. Add Elastic dependency.
   3. Add logback-spring.xml.
   4. Add Zalando Logbook dependency.
   5. Set Zalando Logbook log level to TRACE.
5. Setup API documentation.
   1. Add springdoc-openapi-ui dependency.
   2. Add OpenAPI bean.
   3. Verify documentation at http://localhost:<PORT>/swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config#/
6. Create persistence layer.
   1. Add H2 and MariaDB database dependencies.
   2. Add Flyway dependency.
   3. Add JPA entities.
   4. Add repositories and tests.
   5. Add database migrations.
   6. Seed database.
7. Create service layer.
   1. Add services and tests, with request and response DTOs in net library.
8. Create endpoint layer.
   1. Add controllers and integration tests.
   2. Add GlobalControllerExceptionHandler.
9. Verify security.
   1. Secure endpoints in WebSecurityConfig of gateway if necessary.
10. Setup Ansible deployment.
    1. Add host to hosts and hosts.example.
    2. Add service playbook.
    3. Add service playbook to site.yml.
    4. Add service configuration file.
    5. Add credentials to vars, vault and vault.example.