DIRECTORY.md

src

• main
  • java * ShelsonApplication
    • infrastructure
      • config
        • SecurityConfig
        • WebConfig
        • RestTemplateConfig
        • SwaggerConfig
      • exception
        • BusinessException
        • RestExceptionHandler
        • ResourceNotFoundException
    • logging
      • HttpLoggingFilter
      • LoggingInterceptor
      • CustomRequestLoggingFilter
    • application
      • controller
        • CurrencyConversionController
        • HomeController
        • SwaggerRedirectController
      • dto
        • CurrencyConversionDTO
      • routes
        • CurrencyConversionRoute
      • service
        • CurrencyConversionService
        • CurrencyConversionServiceApiResponse
      • processors
        • ExchangeRateProcessor
    • config
      • SharedConfig
      • MethodValidationConfig
      • ProducerConfig
      • CamelConfig
    • domain
      • repository
        • CurrencyConversionRepository
      • model
        • Currency
        • CurrencyConversion
    • console
      • CurrencyConverterConsoleApp

---

Package Documentation

• com.shelson.infrastructure.config This package contains the configuration settings for the application infrastructure.

• com.shelson.infrastructure.exception This package contains the exception classes for the application infrastructure.

• com.shelson.logging This package contains classes related to logging in the application.

• com.shelson.application.controller This package contains the REST controllers for the application.

  Controllers are responsible for receiving HTTP requests, processing those requests, and returning HTTP responses.

• com.shelson.application.dto This package contains the Data Transfer Objects (DTOs) used to transfer data between the layers of the application.

• com.shelson.application.routes This package contains Camel routes for the currency conversion application. The routes handle incoming requests for currency conversion, process them using the CurrencyConversionService, and return the conversion results.

  The main route in this package is {@link com.shelson.application.routes.CurrencyConversionRoute}, which processes the conversion by extracting headers from the request, validating them, and invoking the service to perform the conversion.

• com.shelson.application.service This package contains the services of the application, responsible for business logic.

• com.shelson.config This package contains the configuration classes for the application. It includes configuration for Camel routes, shared application settings, and any other necessary configurations.

• com.shelson.domain.repository This package contains the repositories for the application, responsible for communication with the database.

• com.shelson.domain.model This package contains the domain model classes of the application.

• com.shelson.console This package contains the console application for currency conversion.

Wiki Menu

Home Page

1. Introduction to the Project

• Overview: Presentation of the project, highlighting its purpose and the context in which it is embedded.
• Project Objectives: Enumeration of the main objectives that the project aims to achieve.
• Scope and Functionalities: Description of the main functionalities offered by the project and its scope of operation.

2. Configuration and Installation

• Initial Configurations: Steps required to set up the development or production environment.
• Installation Instructions: Detailed procedures for installing the project in different environments.
• Docker Configuration: Specifications on how to configure and use Docker for the project.

3. Project Structure

• Folder Structure
• Project Architecture: Explanation of the architecture used, including design patterns and technical decisions.

4. Development

• Apache Camel Integration: Guide on integrating Apache Camel into the project, including configuration and usage.
• Development Flow: Description of the development process adopted, including planning, coding, and review stages.
• Contributors and Authors: Recognition of the contributors to the project.
• Contributions: Guidelines on how to contribute to the project, including code standards and pull request requirements, tips and best practices.
• Code of Conduct: Behavioral guidelines expected for the project community.

5. API and Documentation

• OpenAPI Specification: Details about the OpenAPI specification used to document the API endpoints.
• API Documentation with Swagger: Information on how to access and use the interactive API documentation generated by Swagger.
• Javadoc Documentation: Information on the Javadoc documentation generated for the project.

6. Endpoints and Database

• Endpoint Description: Details of the available API endpoints, including methods, parameters, and usage examples.
• Database Management: Strategies and practices for efficient management of the database used by the project.

7. Testing

• Testing Strategies: Approach and methods used to test the software, including unit, integration, and E2E tests.
• Testing Tools: Description of the testing tools used in the project and how to configure them.

8. CI/CD and Automations

• CI/CD Pipeline: Explanation of the continuous integration and delivery pipeline, detailing each stage and its function.
• Automations and Artifact Generation: Description of the automations incorporated into the CI/CD, including documentation generation and build artifacts.

9. Configuration Files

• .gitignore, .editorconfig and project.properties: Utility of these files to maintain code consistency and quality.
• Maven Wrapper and application.properties: Explanation of how these files help standardize the development environment.
• .env File and Travis CI Settings: Use of these files to configure the environment and CI integrations.

10. Best Practices

• Code Standards and Security: Guidelines for maintaining code quality and security.
• Monitoring and Logging Practices: Recommended techniques for monitoring and logging in the project.

11. Legal and Licensing

• Licensing: Information about the rights and restrictions associated with the use of the software.
• Terms of Use: Information about the terms and conditions for using the software.

12. Projections and Innovations

• Future Plans.
• Improvement Proposals: Space for the community to suggest and debate improvements and innovations.

13. Attachments and Useful Links

• External Links and References: Additional resources and external documentation relevant to the project.

14. Security

• Security Policy: Details on the supported versions, reporting vulnerabilities, and general security practices.