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 @@
# 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
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: 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