Skip to content

AGENTS.md

Latest commit

 

History

History
44 lines (33 loc) · 3.16 KB

AGENTS.md

File metadata and controls

44 lines (33 loc) · 3.16 KB
Raw

Local Agent Instructions (Neurostore Monorepo)

First step in every session

  1. Confirm repo root: pwd should be /home/jdkent/projects/neurostore.
  2. Open and follow .github/copilot-instructions.md before running builds/tests.
  3. If anything is unclear, fallback to .github/workflows/workflow.yml.

Test execution source of truth

  • Use the commands in .github/copilot-instructions.md under ## Testing - Set Long Timeouts.
  • Do not invent alternate test commands unless the documented ones fail.

Canonical backend test commands

  • Store:
    • cd store
    • docker compose exec -T store-pgsql17 bash -lc "psql -U postgres -tAc \"SELECT 1 FROM pg_database WHERE datname = 'store_test_db'\" | grep -q 1 || psql -U postgres -c \"create database store_test_db\""
    • docker compose run -e "APP_ENV=docker_test" --rm neurostore bash -c "python -m pytest neurostore/tests"
  • Compose:
    • cd compose
    • docker compose exec -T compose-pgsql17 bash -lc "psql -U postgres -tAc \"SELECT 1 FROM pg_database WHERE datname = 'compose_test_db'\" | grep -q 1 || psql -U postgres -c \"create database compose_test_db\""
    • docker compose run -e "APP_ENV=docker_test" --rm compose bash -c "python -m pytest neurosynth_compose/tests"

Neurosynth frontend (compose/neurosynth-frontend)

From monorepo root, cd compose/neurosynth-frontend first. First-time setup (.env.dev, npm install) is documented in .github/copilot-instructions.md § Frontend Development.

  • Dev server: npm run start:dev — Vite at http://localhost:3000
  • Staging server: npm run start:staging — same Vite server, but with --mode staging so it loads .env.staging (staging backend URLs, Auth0 config). Create .env.staging alongside .env.dev before first use.
  • Unit tests (Vitest): npm run test
  • Cypress E2E (headless): npm run cy:e2e-headless — expects the app at baseUrl in cypress.config.ts (http://localhost:3000); full flows need backend services as described in copilot-instructions. Use npm run cy:e2e-headless-dev to load .env.dev via env-cmd.
  • Cypress E2E against staging: Run npm run start:staging first, then use the matching staging script so Cypress and the app read the same env file:
  • npm run cy:e2e-headless-staging — full headless run with .env.staging
  • npm run cy:e2e-headless-staging-single -- <path/to/spec.cy.tsx> — single spec, headless
  • npm run cy:e2e-browser-staging — interactive Chrome runner (npm run cy:e2e-browser-dev is the dev equivalent)
  • Don't mix modes (for example, a dev server with staging Cypress); intercepts and auth will not match. If it's unclear whether DEV or STAGING is the target, ask.
  • Staging build: npm run build:staging — builds, prerenders, and generates the sitemap with --mode staging.
  • Embedded terminals / agents: If Cypress fails during binary verification with bad option: --smoke-test (or similar), Electron was started with Node-mode env; prefix the command with env -u ELECTRON_RUN_AS_NODE (e.g. env -u ELECTRON_RUN_AS_NODE npm run cy:e2e-headless).

Quick path check

  • If you are not sure where the file is, run:
    • test -f .github/copilot-instructions.md && echo found