Skip to content

docs: fix apps/api mislabel and the broken local-dev filter command #668

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

Open
funmilayo-ui wants to merge 1 commit into
base: main
Choose a base branch
from
+7 −3
Open

docs: fix apps/api mislabel and the broken local-dev filter command #668

Show file tree
Hide file tree
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
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -158,10 +158,12 @@ Meridian is a pnpm monorepo managed with Turborepo:
meridian/
apps/
web/ -- Vite + React frontend (Freighter wallet, yield dashboard)
api/ -- Fastify API (yield aggregation, Soroban tx building)
api-local/ -- Fastify API, local dev only (yield aggregation, Soroban tx building)
docs/ -- Documentation site
landing/ -- Landing page
api/ -- Vercel serverless functions (api/v1/...), the production API
packages/
api-core/ -- Framework-agnostic route handlers shared by both servers
contracts/ -- Soroban smart contracts (Rust)
shared/ -- Shared utilities used by both api and web
stellar-sdk-helpers/ -- Typed wrappers around @stellar/stellar-sdk
Expand Down
4 changes: 3 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,12 @@ Inflation in many West African economies regularly exceeds 20 % annually. Access
meridian/
├── apps/
│ ├── web/ # Vite + React 19 dashboard (TypeScript, Tailwind, Zustand)
│ ├── api/ # Fastify REST API (local dev): builds Soroban txs, aggregates APY
│ ├── api-local/ # Fastify REST API (local dev only): builds Soroban txs, aggregates APY
│ ├── docs/ # Internal architecture and operations docs
│ └── landing/ # Marketing landing page
├── api/ # Vercel serverless functions (api/v1/...) — the production API
├── packages/
│ ├── api-core/ # Framework-agnostic route handlers shared by both servers
│ ├── stellar-sdk-helpers/ # Blend & DeFindex client wrappers
│ ├── shared/ # Zod schemas, constants, pure utils
│ └── contracts/ # Soroban smart contracts (Rust): vault, blend-adapter, defindex-adapter
Expand Down
2 changes: 1 addition & 1 deletion apps/docs/operations/local-development.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The Vite dev server proxies `/api/*` to `http://localhost:3001` and `/docs/*` to
pnpm --filter @meridian/web dev

# API only
pnpm --filter @meridian/api dev
pnpm --filter @meridian/api-local dev
```

## Health check
Expand Down