Agent Guide

Commands

Check package.json for available scripts

Architecture

Full-stack Rust + React monorepo with pnpm workspace
Backend: Rust/Axum API server (port 3001) with Tokio async runtime
Frontend: React 18 + TypeScript + Vite (port 3000) with shadcn/ui components
Shared: Common TypeScript types in /shared/types.ts
API: REST endpoints at /api/* proxied from frontend to backend in dev

Code Style

Rust: Standard rustfmt, snake_case, derive Debug/Serialize/Deserialize
TypeScript: Strict mode, @/ path aliases, interfaces over types
React: Functional components, hooks, Tailwind classes
Imports: Workspace deps, @/ aliases for frontend, absolute imports
Naming: PascalCase components, camelCase vars, kebab-case files

Managing Shared Types Between Rust and TypeScript

ts-rs allows you to derive TypeScript types from Rust structs/enums. By annotating your Rust types with #[derive(TS)] and related macros, ts-rs will generate .ts declaration files for those types. When making changes to the types, you can regenerate them using npm run generate-types Do not manually edit shared/types.ts, instead edit backend/src/bin/generate_types.rs

Working on the frontend AND the backend

When working on any task that involves changes to the backend and the frontend, start with the backend. If any shared types need to be regenerated, regenerate them before starting the frontend changes.

Testing your work

npm run check - runs cargo and tsc checks

Backend data models

SQLX queries should be located in backend/src/models/* Use getters and setters instead of raw SQL queries where possible.

1.7 KiB Raw Blame History