최상단을 프로젝트 단위로 평평하게 둔다 — o2o-negosium 과 같은 규약이고, 이 레포만
다르게 갈 이유가 없다. negodata/{backend,front} 가 프로젝트 안에서 f/b 를 가르는 선례,
lps-admin/ 이 백엔드 없이 프론트만 가진 최상단 폴더의 선례다.
backend/ frontend/{admin,site,shared} → solution/{backend,front,site,shared} + admin/
## 왜
내부 라우트(/local-content, /places/:id/seo)의 이름과 화면 코드가 사장님 번들에
그대로 실려 나가고 있었다. UserRole.DEVELOPER 주석의 "고객사에 존재를 노출하지 않는다"를
번들이 깨고 있었다 — 라우트 가드는 화면을 가리지 번들은 못 가린다.
번들을 갈라 확인했다: 사장님 dist 에서 local-content · /places · SeoAudit 이 전부 0건이다.
그 과정에서 두 곳이 더 새고 있었다.
- AppShell 의 NAV 배열이 내부 메뉴를 하드코딩하고 있었다. 앱을 가른 뒤에도 dist 에
local-content 가 남아서 찾았다. 메뉴는 이제 앱이 prop 으로 들고 온다.
- EditorHeader·BuilderPage·LoginPage 가 /places 로 링크하고 있었다. 그 화면이 admin 으로
나갔으니 사장님 앱에서는 404 다. 링크를 걷어내고 LoginPage 기본 도착지는 '/' 로 바꿨다
(앱마다 홈이 다르고 각 라우터의 '/' 가 이미 그걸 안다).
## admin 에 백엔드를 두지 않았다
내부 화면이 부르는 훅이 전부 router/v1/{place,fact,local,validator} 에 이미 있다.
자체 백엔드를 두면 place·fact·link 를 같은 DB 에 대고 두 번 구현하게 된다.
대가는 solution/backend 가 죽으면 admin 도 멈추는 것 — 내부 도구라 감수한다.
## admin 의 `@` 는 solution/front/src 를 가리킨다
내부 화면이 쓰는 API 클라이언트·UI·수집 배선이 solution 에 한 벌만 있고 그 파일들끼리도
`@/...` 로 서로를 부른다. admin 에서 `@` 를 자기 src 로 잡으면 그 참조가 전부 깨진다
(실측 TS2307 14건). 복제하는 길도 있지만 RecollectPanel 주석이 금지한다 —
"수집 경로를 두 벌 만들면 확정 게이트"가 갈라진다.
admin 자기 파일만 `@admin` 이고, 의존 방향은 admin → solution 한 쪽뿐이다.
admin 이 여는 빌더는 다른 오리진이라 절대 URL + 새 탭이다(admin/src/lib/solutionUrl.ts).
react-router Link 로 두면 admin 안에서 라우트를 찾다 404 다.
## 그 밖
- npm 워크스페이스 루트를 레포 루트로 올렸다(admin 이 solution 밖이라).
- docker-compose 를 255→174줄로 줄이고 admin(:3002) 서비스를 넣었다. ADMIN_BIND 기본값은
127.0.0.1 — 0.0.0.0 으로 열면 앱을 가른 의미가 없다.
- 발행 호스트를 프론트 .env 에 따로 적지 않는다. compose 가 루트의 SITE_PUBLIC_HOST 를
VITE_PUBLISH_HOST 로 흘려보낸다 — 두 곳에 적으면 canonical 과 화면 주소가 조용히 갈라진다.
- nginx/site.conf 를 git 에서 빼고 .example 만 남겼다(.env·*.toml 과 같은 규약).
compose 가 bind mount 하므로 클론 직후 복사해야 한다 — 없으면 Docker 가 그 자리에
디렉토리를 만들어 nginx 가 설정 없이 뜬다.
- config.test.toml.example 을 추가했다. 없으면 클론한 사람이 pytest 를 아예 못 돌린다
(conftest import 단계에서 죽는다). 외부 API 키는 전부 빈값이다 —
APP_ENV=test 가 .env 를 안 읽는 이유를 여기서 우회하면 안 된다.
- 경로가 한 칸 깊어져 test_schema_ddl(parents[2]→[3]) 과 test_site_theme 을 고쳤다.
검증: front·admin·site 전부 lint 0 / build 0. 백엔드 514 passed.
남은 4건(test_build_publish 3 · test_snapshot 1)은 이 변경 전부터 실패하던 것으로,
손대지 않은 메인 체크아웃에서 같은 4건이 같게 실패하는 것을 확인했다.
Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_019uYhHQdssRubirPirrdJJC
6.9 KiB
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:573rmSync). 옛 해시 파일이 사라지므로 새 번들로 일부 사이트만 구우면 나머지는 CSS 가 404 다. → 프리렌더 기동 시 전체 재굽기가 이 구멍을 메운다. - ★ 프론트(
solution/site)를 배포하면 반드시 전체 재굽기 + 전체 재업로드.azure_static.publish(slug)는 공용 자산 +s/<slug>만 올린다 — 렌더러를 고쳐도 다른 사이트에는 반영되지 않는다. →docker compose restart web후python 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절.
★ 의존 방향은 admin → solution 한 쪽뿐이다. 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/front/.env · admin/.env |
그 앱에만 있는 VITE_* |
★ 두 곳에 같은 값을 적지 않는다. 발행 호스트는 compose 가 루트의 SITE_PUBLIC_HOST 를
VITE_PUBLISH_HOST 로 흘려보낸다. 각자 적으면 canonical 과 화면 주소가 조용히 갈라진다.
커밋
- 한 커밋 = 한 가지 변경. 문서와 그 문서가 설명하는 코드는 같은 커밋에 둔다.
- 커밋 메시지는 한국어로, 무엇을 왜 바꿨는지. 파일 목록은
git이 이미 안다.