Skip to content

docs: add vault concept diagram to README #28

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.

Sign up for GitHub

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

Merged
MugdhoAI merged 1 commit into from
Oct 26, 2026
Merged

docs: add vault concept diagram to README #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,23 @@
[![CI](https://github.com/MugdhoAI/vault-api/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/MugdhoAI/vault-api/actions/workflows/ci.yml)
[![CodeQL](https://github.com/MugdhoAI/vault-api/actions/workflows/codeql.yml/badge.svg?branch=main)](https://github.com/MugdhoAI/vault-api/actions/workflows/codeql.yml)

```mermaid
flowchart TB
VAULT["▣ VAULT API<br/>Authenticated Secret Vault"]
subgraph FLOW["DATA IN MOTION"]
direction LR
D1["•••"] --> D2["key : encrypted value"] --> D3["•••"] --> D4["key : encrypted value"] --> D5["•••"]
end
VAULT -->|"Fernet encrypted at rest"| STORE[("PostgreSQL")]
FLOW -. "secret requests" .-> VAULT

style VAULT fill:#0b1724,stroke:#38bdf8,color:#f0f9ff,stroke-width:2px
style FLOW fill:#080d14,stroke:#26394d,color:#94a3b8
style STORE fill:#102033,stroke:#38bdf8,color:#e0f2fe
style D2 fill:#111827,stroke:#334155,color:#cbd5e1
style D4 fill:#111827,stroke:#334155,color:#cbd5e1
```

A learning-focused FastAPI service for authenticated, owner-scoped secret storage. Secret values are encrypted with Fernet before being persisted to PostgreSQL.

**Status:** This is a learning and portfolio project, not production ready. Do not store real credentials or sensitive data in it.
Expand Down
Loading