diff --git a/.agents/agents.md b/.agents/agents.md new file mode 100644 index 0000000..b604c70 --- /dev/null +++ b/.agents/agents.md @@ -0,0 +1,31 @@ +# sample-react-project - Agent Guide + +This is the agent-facing guide for working in this repository. + +## Project Context +- Sample react project for frontend role-based question + +## 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. +- `yarn start` runs in the foreground — background it the same way. + +## Running the App +- Clone the repo +- Install: `yarn install` +- Dev: `yarn start &` +- Access: `http://localhost:8000` + +## Architecture +- React 16 with create-react-app +- Entry point: `src/index.js` + +## Working Agreement +- Write modular code +- Keep testable +- Incremental validation +- Commit meaningful checkpoints +- Write tests +- Validate before handoff diff --git a/.agents/agents.yaml b/.agents/agents.yaml new file mode 100644 index 0000000..0ed1d1d --- /dev/null +++ b/.agents/agents.yaml @@ -0,0 +1,27 @@ +repo: + name: sample-react-project + description: Sample react project for frontend role-based question + owner: hackerrank + +prerequisites: + - name: GitHub CLI + - name: yarn + - name: node + version: '>=14.0.0' + +setup: + - yarn install + - yarn start + +dev: + command: yarn start + port: 8000 + +build: + command: yarn build + +test: + command: yarn test + +lint: + command: yarn lint