Merge pull request #172 from refactor-group/add_mailersend

Add mailersend

Author: calebbourg

.github/workflows/deploy_to_do.yml

@@ -112,6 +112,11 @@ jobs:
           # JWT signing key for TipTap
           TIPTAP_JWT_SIGNING_KEY=${{ secrets.TIPTAP_JWT_SIGNING_KEY }}
 
+          # -------- Mailersend Config
+          # Template ID for welcome emails
+          WELCOME_EMAIL_TEMPLATE_ID=${{ vars.WELCOME_EMAIL_TEMPLATE_ID }}
+          MAILERSEND_API_KEY=${{ vars.MAILERSEND_API_KEY }}
+
           # -------- Frontend Config
           # Docker image for frontend
           FRONTEND_IMAGE_NAME=${{ vars.FRONTEND_IMAGE_NAME }}

Cargo.lock

@@ -62,19 +62,37 @@ To run the backend directly outside of a container:
 The first example will start the backend with log level DEBUG and attempt to connect to a Postgres DB server on the same machine with user `refactor` and password `password` on port `5432` and selecting the database named `refactor_platform`.
 
 ```bash
-cargo run --  --tiptap-url https://<TIPTAP_APP_ID>.collab.tiptap.cloud --tiptap-auth-key=<TIPTAP_API_SECRET> --tiptap-jwt-signing-key=<TIPTAP_CLOUD_APP_SECRET> --tiptap-app-id=<TIPTAP_APP_ID>
+cargo run --  --tiptap-url https://<TIPTAP_APP_ID>.collab.tiptap.cloud --tiptap-auth-key=<TIPTAP_API_SECRET> --tiptap-jwt-signing-key=<TIPTAP_CLOUD_APP_SECRET> --tiptap-app-id=<TIPTAP_APP_ID> --mailersend-api-key=<MAILERSEND_API_KEY> --welcome-email-template-id=<MAILERSEND_TEMPLATE_ID>
 ```
 
 To run with a custom Postgresql connection string:
 
 ```bash
-cargo run -- -d postgres://refactor:my_password@localhost:5432/refactor_platform --tiptap-url https://<TIPTAP_APP_ID>.collab.tiptap.cloud --tiptap-auth-key=<TIPTAP_API_SECRET> --tiptap-jwt-signing-key=<TIPTAP_CLOUD_APP_SECRET> --tiptap-app-id=<TIPTAP_APP_ID>
+cargo run -- -d postgres://refactor:my_password@localhost:5432/refactor_platform --tiptap-url https://<TIPTAP_APP_ID>.collab.tiptap.cloud --tiptap-auth-key=<TIPTAP_API_SECRET> --tiptap-jwt-signing-key=<TIPTAP_CLOUD_APP_SECRET> --tiptap-app-id=<TIPTAP_APP_ID> --mailersend-api-key=<MAILERSEND_API_KEY> --welcome-email-template-id=<MAILERSEND_TEMPLATE_ID>
 ```
 
 To run with an additional list of allowed cross-site network origins:
 
 ```bash
-cargo run -- --allowed-origins="http://192.168.1.2:3000,https://192.168.1.2:3000" --tiptap-url https://<TIPTAP_APP_ID>.collab.tiptap.cloud --tiptap-auth-key=<TIPTAP_API_SECRET> --tiptap-jwt-signing-key=<TIPTAP_CLOUD_APP_SECRET> --tiptap-app-id=<TIPTAP_APP_ID>
+cargo run -- --allowed-origins="http://192.168.1.2:3000,https://192.168.1.2:3000" --tiptap-url https://<TIPTAP_APP_ID>.collab.tiptap.cloud --tiptap-auth-key=<TIPTAP_API_SECRET> --tiptap-jwt-signing-key=<TIPTAP_CLOUD_APP_SECRET> --tiptap-app-id=<TIPTAP_APP_ID> --mailersend-api-key=<MAILERSEND_API_KEY> --welcome-email-template-id=<MAILERSEND_TEMPLATE_ID>
+```
+
+### Email Configuration
+
+The platform uses MailerSend for transactional emails. To configure email functionality:
+
+1. **Environment Variables** (for Docker):
+   - `MAILERSEND_API_KEY`: Your MailerSend API key
+   - `WELCOME_EMAIL_TEMPLATE_ID`: The template ID for welcome emails
+
+2. **Command Line Arguments** (for direct execution):
+   - `--mailersend-api-key`: Your MailerSend API key
+   - `--welcome-email-template-id`: The template ID for welcome emails
+
+Example:
+```bash
+export MAILERSEND_API_KEY="your-api-key"
+export WELCOME_EMAIL_TEMPLATE_ID="your-template-id"
 ```
 
 ---

README.md

@@ -82,6 +82,8 @@ services:
       TIPTAP_URL: ${TIPTAP_URL}
       TIPTAP_AUTH_KEY: ${TIPTAP_AUTH_KEY}
       TIPTAP_JWT_SIGNING_KEY: ${TIPTAP_JWT_SIGNING_KEY}
+      MAILERSEND_API_KEY: ${MAILERSEND_API_KEY}
+      WELCOME_EMAIL_TEMPLATE_ID: ${WELCOME_EMAIL_TEMPLATE_ID}
       PLATFORM: ${PLATFORM}
     depends_on:
       - migrator

docker-compose.yaml

@@ -35,6 +35,7 @@ The Refactor Platform is a coaching management system built with Rust (Axum back
 ### External Integrations
 - **TipTap**: Collaborative document editing service
 - **JWT**: Token generation and validation service
+- **MailerSend**: Transactional email service for notifications
 
 ## Data Flow Example
 
@@ -84,6 +85,7 @@ graph TB
     %% External Services
     TipTap[TipTap Gateway<br/>Document Collaboration]
     JWT[JWT Service<br/>Token Generation]
+    MailerSend[MailerSend<br/>Email Service]
     
     %% Request Flow
     Client --> Nginx
@@ -135,6 +137,7 @@ graph TB
     %% External Integrations
     Domain --> TipTap
     Domain --> JWT
+    Domain --> MailerSend
     
     %% Styling
     classDef external fill:#e1f5fe

docs/architecture/system_architecture_diagram.md

@@ -59,6 +59,12 @@ FRONTEND_SERVICE_PORT=3000                   # Port for the front-end service
 
 PLATFORM="linux/arm64/v8"                    # Or linux/amd64
 
+# ==============================
+#   Email Service Configuration
+# ==============================
+MAILERSEND_API_KEY=""                        # MailerSend API key for sending emails
+WELCOME_EMAIL_TEMPLATE_ID=""                 # Template ID for welcome emails
+
 # ==============================
 #   TipTap Service Configuration
 # ==============================

docs/runbooks/Container-README.md

@@ -5,15 +5,23 @@ edition = "2021"
 
 [dependencies]
 chrono = { version = "0.4.38", features = ["serde"] }
+email_address = "0.2"
 entity_api = { path = "../entity_api" }
 jsonwebtoken = "9"
 service = { path = "../service" }
 log = "0.4.22"
 reqwest = { version = "0.12.12", features = ["json", "rustls-tls"] }
 serde_json = "1.0.128"
 serde = {version = "1.0.210", features = ["derive"] }
+tokio = { version = "1.0", features = ["full"] }
 
 [dependencies.sea-orm]
 version = "1.1.0"                                                       # sea-orm version
 features = ["debug-print", "runtime-tokio-native-tls", "sqlx-postgres"]
 
+[dev-dependencies]
+mockito = "1.6"
+serial_test = "3.1"
+
+
+