o2o-site-AEO/AGENTS.md
Mina Choi c85c577349 이름: solution/front → solution/frontend
`backend` 옆에 `front` 가 있을 이유가 없었다. negosium 의 negodata/front 를 그대로
베꼈고 그게 왜 front 인지는 따져보지 않았다 — 근거 없이 들여온 이름이라 바로잡는다.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019uYhHQdssRubirPirrdJJC
2026-08-31 15:27:16 +09:00

6.9 KiB

AGENTS.md — 이 레포에서 작업하기 전에

에이전트와 신규 합류자가 먼저 읽는 파일이다. 여기에는 밟기 쉬운 함정규약만 둔다. 설명은 각 문서가 단일 출처다 — 여기로 복사하지 말고 링크한다.

궁금한 것 문서
이 제품이 뭘 푸나 · 안 하기로 한 것 docs/PRODUCT.md
어떻게 도나 · 앱 경계 docs/ARCHITECTURE.md
다음에 뭘 만드나 (우선순위 P0~P4) docs/DEVELOPMENT_DIRECTION.md
미결 사항 · 코드가 그걸 어떻게 격리했나 docs/DECISIONS.md
서버에 올릴 때 docs/DEPLOY.md

이 레포의 한 가지 규칙

백엔드는 HTML 을 만들지 않는다. payload JSON 을 파일로 떨어뜨리고, Node 프리렌더가 그걸 읽어 정적 사이트를 굽는다. 두 쪽은 서로를 모르고 디렉토리 하나로만 만난다. 이 경계를 넘는 변경은 하기 전에 ARCHITECTURE.md 1절을 읽는다.

반드시 알아야 할 함정

밟으면 조용히 틀린다 — 빌드는 성공하고 화면도 뜨는데 결과가 잘못된 종류다.

  • 번들 파일명은 콘텐츠 해시다. HTML 은 /assets/index-DvNTmLhy.css루트 절대경로로 가리킨다. 경로는 프리렌더가 dist/client/.vite/manifest.json 에서 읽어 박는다 (prerender.ts:160). 렌더러 CSS 를 고치면 이름이 바뀐다.
  • 로컬 out/assets 는 빌드마다 통째로 갈린다 (prerender.ts:573 rmSync). 옛 해시 파일이 사라지므로 새 번들로 일부 사이트만 구우면 나머지는 CSS 가 404 다. → 프리렌더 기동 시 전체 재굽기가 이 구멍을 메운다.
  • ★ 프론트(solution/site)를 배포하면 반드시 전체 재굽기 + 전체 재업로드. azure_static.publish(slug) 는 공용 자산 + s/<slug> 만 올린다 — 렌더러를 고쳐도 다른 사이트에는 반영되지 않는다.docker compose restart webpython scripts/republish_all.py
  • 발행 호스트는 두 곳에 있고 같아야 한다. 백엔드 SITE_PUBLIC_HOST(기본 w4ai.o2o.kr, site_payload.py) ↔ 프론트 VITE_PUBLISH_HOST. canonical·og:url·sitemap·IndexNow 가 전부 이 값을 쓴다. 그리고 origin 은 payload JSON 에 구워진다 — 호스트를 바꾸면 프리렌더 재실행만으로는 안 되고 백엔드에서 재발행해 payload 를 다시 만들어야 한다.
  • AZURE_STORAGE_PREFIX 와 루트 절대경로는 충돌한다. HTML 이 /assets/… 를 가리키는데 블롭은 ai-for-web/assets/… 에 놓인다. 접두사를 쓰려면 오리진 경로를 /ai-for-web 로 잡는 CDN 을 앞에 세워야 한다. 아니면 비워라. (프리렌더는 서브패스 마운트를 지원한다 — basePath/sites/s/joy 면 자산은 /sites/assets.)
  • AZURE_STORAGE_CONTAINER=$web — 셸에서 export 할 땐 반드시 작은따옴표('$web').
  • 슬러그 규칙은 두 곳에 있고 같아야 한다: site_payload.publish_slug()solution/shared/src/lib/slug.ts publishUrl. 어긋나면 발행은 성공하고 주소만 404 다.
  • 디렉토리 요청 → index.html. /s/<slug>끝 슬래시 없이 열려야 한다. 정적 서버를 바꾸든 nginx 설정을 만지든 이 규칙부터 확인한다.

코드 규약

  • 미결 사항은 코드로 풀지 않는다. DECISIONS.md 1절이 보류한 것은 플래그·어댑터로 격리해 두고, 결론이 나면 날짜와 함께 결론을 적고 격리를 제거한다.
  • 수집 어댑터를 추가하기 전에 DECISIONS.md 1-1 과 DATA_SOURCE_RESEARCH.md를 읽는다. 봇 탐지 우회는 결론과 무관하게 영구 금지다.
  • 주석은 "왜"를 적는다. 이 레포의 기존 주석이 그 톤이다 — 실측값, 밟았던 함정, 안 한 이유. 코드를 읽으면 알 수 있는 "무엇"은 쓰지 않는다.
  • 문서는 코드와 같은 커밋에서 고친다. 동작을 바꿨는데 문서를 안 고쳤으면 미완이다.

레포 구조

solution/    사장님 — backend(FastAPI+워커) · front(빌더) · site(발행물) · shared(계약)
admin/       우리 — 전체 사이트 운영. **프론트 전용, 백엔드 없음**

최상단은 프로젝트 단위다(o2o-negosium 과 같은 규약). frontend/ backend/ 를 최상단 묶음 폴더로 쓰지 않는다. 근거와 경계는 ARCHITECTURE.md 4절.

의존 방향은 adminsolution 한 쪽뿐이다. admin 이 수집 배선·UI 를 재수출로 가져다 쓴다 (admin/src/** 의 얇은 파일들). 반대 방향이 생기면 번들을 가른 의미가 사라진다.

실행

docker compose up -d                      # API :9800 · 워커 · web :3000 · admin :3002 · nginx :80
docker compose logs -f worker
  • 사장님 앱: http://localhost:3000 · 내부 운영: http://localhost:3002
  • 발행 사이트: http://localhost:3000/s/<slug> (front Vite 가 :3001 정적서버로 프록시)
  • 클론 직후 1회: cp .env.example .env · cp nginx/site.conf.example nginx/site.conf (후자를 빼먹으면 Docker 가 그 자리에 디렉토리를 만들어 nginx 가 설정 없이 뜬다)
  • DB 는 compose 밖이다 (호스트 PostgreSQL, host.docker.internal). 스키마는 postgres-init/init-data/init.sql 한 벌이다 — 누적 ALTER 파일은 없다
  • npm 워크스페이스 루트는 레포 루트다. npm install 은 루트에서 한 번. npm run dev:front / dev:admin / dev:site
  • 백엔드 스크립트는 solution/backend/ 에서 .venv/bin/python scripts/<name>.py
  • 테스트: solution/backend/ 에서 .venv/bin/pytest. APP_ENV=test.env 를 읽지 않는다 — 실키가 테스트로 새어 외부 API 요금이 나가는 경로를 막아 뒀다

.env 는 어디에 두나

루트 .env 가 단일 출처다. compose 가 이 파일만 읽고(${...} 치환 + env_file), Vite 앱은 구조상 자기 디렉토리의 .env 읽는다 — 그래서 나뉘어 있는 것이지 취향이 아니다.

파일 담는 것
.env DB · JWT · 외부 API 키 · SITE_PUBLIC_HOST · INDEXNOW_KEY
solution/frontend/.env · admin/.env 그 앱에만 있는 VITE_*

두 곳에 같은 값을 적지 않는다. 발행 호스트는 compose 가 루트의 SITE_PUBLIC_HOSTVITE_PUBLISH_HOST 로 흘려보낸다. 각자 적으면 canonical 과 화면 주소가 조용히 갈라진다.

커밋

  • 한 커밋 = 한 가지 변경. 문서와 그 문서가 설명하는 코드는 같은 커밋에 둔다.
  • 커밋 메시지는 한국어로, 무엇을 왜 바꿨는지. 파일 목록은 git 이 이미 안다.