Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Refactor FastAPI Codebase to Follow Hexagonal/Clean Architecture #1

Open
Arghya721 opened this issue Aug 29, 2024 · 0 comments
Open
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@Arghya721
Copy link
Owner

Issue Description:

The current FastAPI codebase must be refactored to follow a more structured and maintainable architecture, such as Hexagonal or Clean Architecture. This will involve reorganizing the existing code to ensure separation of concerns, improve testability, and enhance the flexibility to adapt to future changes.

Tasks:

  • Identify core components of the FastAPI application (e.g., routes, services, repositories, etc.).
  • Define boundaries and layers in accordance with Hexagonal or Clean Architecture principles.
  • Refactor existing code to align with the chosen architecture, ensuring minimal disruption to current functionality.
  • Update or create new unit tests to cover the refactored components.
  • Document the new architecture and code structure to guide future development.

Expected Outcome:

  • A well-organized codebase with clear separation between different layers (e.g., domain, application, infrastructure).
  • Improved maintainability and scalability of the FastAPI application.
  • Comprehensive documentation to support ongoing and future development efforts.
@Arghya721 Arghya721 added documentation Improvements or additions to documentation help wanted Extra attention is needed good first issue Good for newcomers labels Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant