feat: enhance email and utility modules with new features

- Updated SMTP configuration in .env and docker-compose.override.yml to use MailHog for email testing
- Added utils module with health check and test email endpoints
- Implemented event handling for password reset requests, integrating with the email service
- Improved email service to send password reset emails upon event trigger
- Removed deprecated files and updated documentation to reflect new module structure

These changes contribute to the ongoing development of the modular monolith architecture, enhancing email functionality and introducing utility endpoints for better service management.

Author: Fguedes90

.env

@@ -23,16 +23,16 @@ FIRST_SUPERUSER=admin@example.com
 FIRST_SUPERUSER_PASSWORD=SecureAdminPass123!
 
 # Emails
-SMTP_HOST=
+SMTP_HOST=mailhog
 SMTP_USER=
 SMTP_PASSWORD=
 EMAILS_FROM_EMAIL=info@example.com
-SMTP_TLS=True
+SMTP_TLS=False
 SMTP_SSL=False
-SMTP_PORT=587
+SMTP_PORT=1025
 
 # Postgres
-POSTGRES_SERVER=localhost
+POSTGRES_SERVER=db
 POSTGRES_PORT=5432
 POSTGRES_DB=app
 POSTGRES_USER=postgres

.gitignore

@@ -3,4 +3,4 @@ node_modules/
 /test-results/
 /playwright-report/
 /blob-report/
-/playwright/.cache/
+/playwright/.cache/

CLAUDE.md

@@ -24,6 +24,17 @@
 - 🚢 Deployment instructions using Docker Compose, including how to set up a frontend Traefik proxy to handle automatic HTTPS certificates.
 - 🏭 CI (continuous integration) and CD (continuous deployment) based on GitHub Actions.
 
+## Documentation
+
+For comprehensive documentation on how to use, develop, and extend this template, see the [documentation](./docs/README.md).
+
+Key documentation sections:
+
+- [Getting Started](./docs/01-getting-started/01-prerequisites.md) - Prerequisites and initial setup
+- [Architecture Overview](./docs/02-architecture/01-overview.md) - Modular monolith architecture design
+- [Development Workflow](./docs/03-development-workflow/) - Day-to-day development guidelines
+- [Extending the API](./docs/04-guides/01-extending-the-api.md) - How to add new modules and features
+
 ### Dashboard Login
 
 [![API docs](img/login.png)](https://github.com/fastapi/full-stack-fastapi-template)
@@ -138,7 +149,7 @@ Before deploying it, make sure you change at least the values for:
 
 You can (and should) pass these as environment variables from secrets.
 
-Read the [deployment.md](./deployment.md) docs for more details.
+Read the [deployment documentation](./docs/06-deployment/README.md) for more details.
 
 ### Generate Secret Keys
 
@@ -152,29 +163,6 @@ python -c "import secrets; print(secrets.token_urlsafe(32))"
 
 Copy the content and use that as password / secret key. And run that again to generate another secure key.
 
-
-## Backend Development
-
-Backend docs: [backend/README.md](./backend/README.md).
-
-## Frontend Development
-
-Frontend docs: [frontend/README.md](./frontend/README.md).
-
-## Deployment
-
-Deployment docs: [deployment.md](./deployment.md).
-
-## Development
-
-General development docs: [development.md](./development.md).
-
-This includes using Docker Compose, custom local domains, `.env` configurations, etc.
-
-## Release Notes
-
-Check the file [release-notes.md](./release-notes.md).
-
 ## License
 
-The Full Stack FastAPI Template is licensed under the terms of the MIT license.
+The Full Stack FastAPI Template is licensed under the terms of the MIT license.

README.md

@@ -0,0 +1,41 @@
+"""
+Utils module initialization.
+
+This module provides utility endpoints and functions.
+"""
+from fastapi import APIRouter, FastAPI
+
+from app.core.config import settings
+from app.core.logging import get_logger
+
+# Configure logger
+logger = get_logger("utils_module")
+
+
+def get_utils_router() -> APIRouter:
+    """
+    Get the utils module's router.
+
+    Returns:
+        APIRouter for utils module
+    """
+    from app.modules.utils.api.routes import router as utils_router
+    return utils_router
+
+
+def init_utils_module(app: FastAPI) -> None:
+    """
+    Initialize the utils module.
+
+    This function sets up routes for the utils module.
+
+    Args:
+        app: FastAPI application
+    """
+    from app.modules.utils.api.routes import router as utils_router
+
+    # Include the utils router in the application
+    app.include_router(utils_router, prefix=settings.API_V1_STR)
+
+    # Log initialization
+    logger.info("Utils module initialized")

app/modules/utils/__init__.py

@@ -0,0 +1,3 @@
+"""
+Utils API package.
+"""

app/modules/utils/api/__init__.py

@@ -0,0 +1,57 @@
+"""
+Utils routes.
+
+This module provides API routes for utility operations.
+"""
+from typing import Any
+
+from fastapi import APIRouter, BackgroundTasks, Depends, HTTPException, status
+from pydantic import EmailStr
+
+from app.api.deps import CurrentSuperuser
+from app.core.config import settings
+from app.core.logging import get_logger
+from app.shared.models import Message  # Using shared Message model
+
+# Configure logger
+logger = get_logger("utils_routes")
+
+# Create router
+router = APIRouter(prefix="/utils", tags=["utils"])
+
+
+@router.get("/health-check/", response_model=bool)
+def health_check() -> Any:
+    """
+    Health check endpoint.
+    
+    Returns:
+        True if the API is running
+    """
+    return True
+
+
+@router.post("/test-email/", response_model=Message)
+def test_email(
+    current_user: CurrentSuperuser,
+    email_to: EmailStr,
+    background_tasks: BackgroundTasks,
+) -> Any:
+    """
+    Test email sending.
+    
+    Args:
+        email_to: Recipient email address
+        background_tasks: Background tasks
+        current_user: Current superuser
+        
+    Returns:
+        Success message
+    """
+    # This endpoint is now handled by the email module
+    # Redirect to the email module's test endpoint
+    raise HTTPException(
+        status_code=status.HTTP_301_MOVED_PERMANENTLY,
+        detail="This endpoint has moved to /api/v1/email/test",
+        headers={"Location": f"{settings.API_V1_STR}/email/test?email_to={email_to}"},
+    )

app/modules/utils/api/routes.py

@@ -6,6 +6,7 @@ script_location = app/alembic
 
 # template used to generate migration files
 # file_template = %%(rev)s_%%(slug)s
+file_template = migration_template.py.mako
 
 # timezone to use when rendering the date
 # within the migration file as well as the filename.