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

docs: add a mermaid plot to the README documenting the API architecture #28

Open
jdhoffa opened this issue Feb 28, 2025 · 1 comment
Open
Labels
documentation Improvements or additions to documentation

Comments

@jdhoffa
Copy link
Collaborator

jdhoffa commented Feb 28, 2025

See an example here:

https://github.com/RMI/engageAct-API/blob/ac04759b3dab5115a4ba49361ac8cf43f7ead0c1/README.md?plain=1#L108-L122

@jdhoffa jdhoffa added the documentation Improvements or additions to documentation label Feb 28, 2025
@jdhoffa
Copy link
Collaborator Author

jdhoffa commented Feb 28, 2025

For example:

graph TD
    subgraph Local Development Env.
        A[Developer's Laptop]
        B[Docker]
        C[FastAPI Application]
        A --> B
        B --> C
    end

    subgraph Azure Cloud
        subgraph App Services
            D[Azure App Service]
            E[FastAPI Application Container]
            D --> E
        end

        subgraph Backing Services
            F[Azure Blob Storage]
            G[Azure Application Insights]
            H[Azure Key Vault]
        end
    end

    subgraph GitHub
        I[CI/CD by GH Actions]
        J[Azure Container Registry]
        I -->|GH Action Push to ACR| J
        J --> D
    end

    C -->|GH Push| I
    E -->|Fetch Data| F
    E -->|Logging & Monitoring| G
    E -->|Secret Management| H
Loading

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
Projects
None yet
Development

No branches or pull requests

1 participant