Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
31 changes: 31 additions & 0 deletions .agents/agents.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
# react-router - Agent Guide

This is the agent-facing guide for working in this repository.

## Project Context
- Declarative routing for React

## Setup
See [`agents.yaml`](./agents.yaml) for prerequisites, commands, and ports.

### Setup Hints
- `nvm` may not be loaded in your shell. If `nvm: command not found`, source it first.
- `npm start` runs in the foreground — background it the same way.

## Running the App
- Clone the repo
- Install: `npm install`
- Dev: `npm start &`
- Access: `http://localhost:3000`

## Architecture
- React routing library (v3)
- Entry point: `modules/index.js`

## Working Agreement
- Write modular code
- Keep testable
- Incremental validation
- Commit meaningful checkpoints
- Write tests
- Validate before handoff
27 changes: 27 additions & 0 deletions .agents/agents.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
repo:
name: react-router
description: Declarative routing for React
owner: ReactTraining

prerequisites:
- name: GitHub CLI
- name: npm
- name: node
version: '>=12.0.0'

setup:
- npm install
- npm start

dev:
command: npm start
port: 3000

build:
command: npm run build

test:
command: npm test

lint:
command: npm run lint