|
3 | 3 | This repo uses Codex-style coding agents. Keep instructions short, concrete, and scoped to this project. |
4 | 4 |
|
5 | 5 | ## Project Layout |
| 6 | + |
6 | 7 | - `apps/webhook_router`: Rust backend (Axum + SQLite) |
7 | 8 | - `apps/console`: React frontend |
8 | 9 | - `docs/`: design notes and specs |
9 | 10 |
|
10 | 11 | ## Backend Conventions |
| 12 | + |
11 | 13 | - SQLite only; support `:memory:` for tests. |
12 | 14 | - No queues; dispatch synchronously. |
13 | 15 | - Webhook endpoints are `POST /ingress/:endpoint_id/:platform`. |
14 | 16 | - Use HTTP Basic Auth for `/api`. |
15 | 17 | - Adapters live in `apps/webhook_router/src/adapters/`. |
16 | 18 |
|
17 | 19 | ## Testing |
| 20 | + |
18 | 21 | - Prefer unit tests near the code (module `#[cfg(test)]`). |
19 | 22 | - Run: `cargo test -p webhook_router`. |
20 | 23 |
|
21 | 24 | ## Docs |
| 25 | + |
22 | 26 | - Update `docs/tech-plan.md` if architecture changes. |
23 | 27 | - Adapter formats live in `docs/adapters/`. |
| 28 | + |
| 29 | +<!-- nx configuration start--> |
| 30 | +<!-- Leave the start & end comments to automatically receive updates. --> |
| 31 | + |
| 32 | +# General Guidelines for working with Nx |
| 33 | + |
| 34 | +- When running tasks (for example build, lint, test, e2e, etc.), always prefer running the task through `nx` (i.e. `nx run`, `nx run-many`, `nx affected`) instead of using the underlying tooling directly |
| 35 | +- You have access to the Nx MCP server and its tools, use them to help the user |
| 36 | +- When answering questions about the repository, use the `nx_workspace` tool first to gain an understanding of the workspace architecture where applicable. |
| 37 | +- When working in individual projects, use the `nx_project_details` mcp tool to analyze and understand the specific project structure and dependencies |
| 38 | +- For questions around nx configuration, best practices or if you're unsure, use the `nx_docs` tool to get relevant, up-to-date docs. Always use this instead of assuming things about nx configuration |
| 39 | +- If the user needs help with an Nx configuration or project graph error, use the `nx_workspace` tool to get any errors |
| 40 | + |
| 41 | +<!-- nx configuration end--> |
0 commit comments