6ae581ab2e
UI: warm daylight design system (Tailwind v4 @theme palette, gh-* component classes, watercolor grain, Zen Maru Gothic + Klee One fonts), animated SSR-safe GhibliBackground (drifting clouds, meadow hills, soot sprites), and a full reskin of navbar, connect button, dapp page, loan cards, settings modal, and readme. Fixes the bg-white-on-dark loan-card inconsistency. Web3/business logic untouched. Docs: converted docs/ into an Obsidian vault (frontmatter, [[wikilinks]], callouts, Home MOC, folders Architecture/Operations/Audits) and added a full-project audit note (Project Audit 2026-06). Redacted a real leaked Schedy key value from the security audit example (rotate it at Schedy). Also commits the previously-untracked server layer: app/api (cron + tasks routes) and lib (redis, ssrf-guard, task-store). Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
61 lines
1.8 KiB
Markdown
61 lines
1.8 KiB
Markdown
---
|
|
title: Docs README
|
|
tags: [mortgagefi, moc]
|
|
type: moc
|
|
status: stable
|
|
updated: 2026-06-14
|
|
---
|
|
|
|
# MortgageFi Documentation
|
|
|
|
This folder is an **Obsidian vault**. Open it in [Obsidian](https://obsidian.md) for backlinks, the graph view, and live wikilinks — or browse the Markdown directly on Git.
|
|
|
|
> [!tip] Start at [[Home]]
|
|
> [[Home]] is the Map of Content with links to every note.
|
|
|
|
## Quick links
|
|
|
|
### Architecture
|
|
- [[Architecture]] — system overview, component diagrams, and data flows
|
|
- [[API Reference]] — REST API for nftcache, the scheduler, and ntfy
|
|
|
|
### Operations
|
|
- [[Deployment]] — Docker Compose, Vercel, and standalone deployment guides
|
|
- [[Development]] — local setup, adding chains, testing, troubleshooting
|
|
- [[Migration Notes]] — library upgrade notes & rollback plan
|
|
- [[Alert Changes]] — notification & scheduling behaviour history
|
|
|
|
### Audits
|
|
- [[Security Audit]] · [[Performance Audit]] · [[Project Audit 2026-06]]
|
|
|
|
## What is MortgageFi?
|
|
|
|
A decentralized mortgage-lending platform that lets users:
|
|
|
|
- **Deposit NFT collateral** into audited debt vaults
|
|
- **Borrow stablecoins** against crypto collateral (cbBTC, WETH, WBTC)
|
|
- **Pay down debt** on-chain to extend liquidation timers
|
|
- **Receive alerts** via email and push notifications before liquidation
|
|
|
|
## Folder layout
|
|
|
|
```
|
|
docs/
|
|
├── Home.md ← Map of Content (start here)
|
|
├── Architecture/
|
|
│ ├── Architecture.md
|
|
│ └── API Reference.md
|
|
├── Operations/
|
|
│ ├── Deployment.md
|
|
│ ├── Development.md
|
|
│ ├── Migration Notes.md
|
|
│ └── Alert Changes.md
|
|
└── Audits/
|
|
├── Security Audit.md
|
|
├── Performance Audit.md
|
|
└── Project Audit 2026-06.md
|
|
```
|
|
|
|
## Related
|
|
[[Home]] · [[Architecture]] · [[Deployment]] · [[Development]]
|