Skip to content

docs: document index.ts modularization roadmap #267

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
brain-marchine wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: document index.ts modularization roadmap #267

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
14 changes: 14 additions & 0 deletions docs/module-layout.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# Module layout roadmap

`src/index.ts` currently hosts routing, middleware, stores, and handlers in
one file (issue #13). The intended split:

| Module | Responsibility |
|--------|----------------|
| `src/routers/` | Express route mounts (`pairs`, `webhooks`, `admin`) |
| `src/middleware/` | CORS, rate limit, security headers, pause guard |
| `src/stores.ts` | In-memory registries (already extracted) |
| `src/validation/` | Shared request validators |

New endpoints should prefer small router modules over growing `index.ts`.
See `docs/middleware-order.md` and `docs/architecture.md` for current flow.