Migrate Backend to Django DRF

[maciej-MKan]

Objective:

The goal of this task is to migrate the backend of our application from FastAPI to Django REST Framework (DRF). The migration should leverage DRF's robust ecosystem, built-in tools, and scalability features, ensuring seamless integration with the existing database and frontend.

Scope of Work:

1. Review Current Backend Architecture:

   Analyze the existing FastAPI codebase to understand its structure, endpoints, models, and dependencies.
   Identify FastAPI-specific features (e.g., Pydantic models, dependency injection, and async endpoints) that need DRF alternatives.
   Document existing API endpoints and ensure they remain consistent for the frontend.

2. Set Up Django Environment:

   Install and configure Django with Django REST Framework (DRF).
   Create a new Django project and set up a scalable structure with apps for modularity.
   Configure database connections and settings to align with the existing database.

3. Database Integration:

   Map existing FastAPI SQLAlchemy models to Django models.
   Use Django migrations to ensure the database schema is compatible.
   Write scripts to handle any data transformation required during migration.

4. API Migration:

   Reimplement FastAPI endpoints as DRF views or viewsets.
   Replace Pydantic models with Django serializers for data validation and transformation.
   Leverage DRF's built-in authentication, permissions, and pagination features to replace FastAPI dependencies.

5. Integrate Key Features:

   Replace FastAPI-specific functionality (e.g., async handling, custom middleware) with DRF and Django equivalents.
   Utilize Django's admin panel for data management as needed.
   Ensure any third-party FastAPI dependencies are replaced with Django-compatible packages.

6. Testing & Debugging:

   Write or adapt unit and integration tests to validate the new DRF backend.
   Thoroughly test API endpoints to ensure compatibility with the frontend.
   Debug issues related to data integrity, performance, or business logic.

7. Documentation:

   Provide detailed documentation on the new DRF backend structure, including setup and deployment instructions.
   Include a migration guide highlighting key differences between FastAPI and DRF.
   Update developer onboarding materials to reflect the switch to Django and DRF.

Acceptance Criteria:

• All FastAPI endpoints must be successfully migrated to DRF with equivalent functionality.
• The new DRF backend must integrate seamlessly with the existing database and frontend.
• Tests must confirm the correctness of all endpoints and business logic.
• The codebase should adhere to Django and DRF best practices, with clean, modular design.
• Comprehensive documentation must be provided for developers to adapt to the new backend.

Timeline:

Day 1:

Set up the Django project and configure the environment.
Begin migrating database models and schema.

Day 2:

Implement simple endpoints and serializers in DRF.
Test initial API functionality.

Day 3:

Migrate complex views and business logic.
Replace FastAPI-specific features with DRF equivalents.

Day 4:

Complete testing and debugging.
Finalize documentation and deployment procedures.