o2o-site-AEO/README.md
Mina Choi 4ff92fb0a6 [docs] docs: 문서 정리 — DEVLOG 요약 · 렌더링 흐름 문서 추가 · 삭제한 방향 문서 링크 정리
DEVLOG 가 1,900줄이 넘어 최근에 무엇을 왜 바꿨는지 찾기 어려웠다.

- DEVLOG.md: 개발 이력상 남길 가치가 있는 항목만 요약
- RENDERING.md: 정적 사이트 · 미리보기 · 발행 세 경우의 흐름과 담당 파일
- README · AGENTS · PRODUCT: 삭제한 DEVELOPMENT_DIRECTION.md 링크 정리(삭제 자체는 앞 커밋),
  admin 은 필요한 규모가 되면 개발한다는 안내, 템플릿 문서 링크

문서만 바꿈

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-09-30 13:45:24 +09:00

4.7 KiB

o2o-web4ai

상호명 하나로 소상공인 홈페이지를 만들어 발행하는 서비스.

목표는 예쁜 사이트가 아니다 — AI 검색과 검색엔진이 이 가게를 "공식 홈페이지 기준"으로 설명하게 만드는 것이다. 그래서 산출물은 SPA 가 아니라 크롤러가 그대로 읽는 정적 HTML 이고, 발행 게이트가 통과시키지 않은 값은 사이트에 나가지 않는다.

  • 무엇을 · 누구를 위해 · 무엇을 안 하는가 → docs/PRODUCT.md
  • 어떻게 도는가 (파이프라인·앱 경계) → docs/ARCHITECTURE.md
  • 에이전트·신규 합류자가 먼저 읽을 규약 → AGENTS.md

실행

cp .env.example .env                              # DB_*, JWT_*, 외부 API 키
cp nginx/site.conf.example nginx/site.conf        # 빼먹으면 nginx 가 설정 없이 뜬다
docker compose up -d
docker compose logs -f solution-worker
주소 공개
사장님 앱 (빌더) http://localhost:3000 외부
발행된 사이트 http://localhost:3000/s/<slug> · 운영은 :80 외부
솔루션 API 문서 http://localhost:9800/docs 외부
내부 운영 화면 http://localhost:3002 127.0.0.1 만
어드민 API 문서 http://localhost:9801/docs 127.0.0.1 만

내부 두 개를 0.0.0.0 으로 열면 앱을 가른 의미가 없다 (ADMIN_BIND · ADMIN_API_BIND).

  • DB 는 compose 밖이다 (호스트 PostgreSQL, host.docker.internal). 스키마는 postgres-init/init-data/init.sql 한 벌 — 누적 ALTER 파일은 없다.
  • npm 워크스페이스 루트는 레포 루트다. npm install 은 여기서 한 번. npm run dev:frontend / dev:admin / dev:site
  • 백엔드 스크립트는 solution/backend/ 에서 .venv/bin/python scripts/<name>.py
  • 테스트는 solution/backend/ 에서 .venv/bin/pytest

레포 구조

solution/          사장님 — 사이트 만들기·관리
  backend/         FastAPI(:9800) + 워커. HTML 은 만들지 않는다 — payload JSON 만 떨어뜨린다
  frontend/        빌더 (위저드 + 에디터 + 발행 게이트)
  site/            발행 사이트. SSR 엔트리 + 프리렌더 + 정적 서버
  shared/          frontend·site·백엔드 계약 (SitePayload · slug · 디자인 토큰)
admin/             우리 — 전체 사이트 운영
  backend/         진입점만(:9801). 도메인 코드는 solution/backend 를 PYTHONPATH 로 쓴다
  frontend/        운영 화면. `@` 별칭이 solution/frontend/src 를 가리킨다
docs/              아래 표
nginx/             발행 사이트 정적 서빙 (site.conf 는 .example 만 커밋)
postgres-init/     스키마 DDL

의존 방향은 admin → solution 한 쪽뿐이다. 반대가 생기면 번들을 가른 의미가 사라진다. 근거는 ARCHITECTURE.md 4절.

admin/ 은 지금 쓰지 않는다. 개발자용 사이트·유저 관리는 solution 앱 안의 개발자 메뉴로 가볍게 처리하고 있다(DEVLOG 2026-09-23). 우리가 따로 관리해야 할 만큼 사이트·운영 규모가 커지면 그때 admin/ 을 개발한다. 그 전에는 새 기능을 여기에 붙이지 않는다.

문서 지도

문서 언제 읽나
docs/PRODUCT.md 이 제품이 뭘 푸는지 · 안 하기로 한 것이 뭔지
docs/ARCHITECTURE.md 발행 파이프라인 전체 · 두 앱과 한 백엔드의 경계
docs/DECISIONS.md 미결 사항과, 코드가 그걸 어떻게 격리해 뒀는지
docs/DEPLOY.md 서버에 올릴 때 · 배포 후 재발행 절차
docs/DATA_SOURCE_RESEARCH.md 어디서 콘텐츠를 가져올 수 있나 (실측 근거)
docs/COLLECTION_SEO_AEO_FLOW.md 수집→LLM→SEO/AEO 현재 구현
docs/API_USAGE.md 외부 API 원가 — 사이트 1건당 $1 상한을 어디서 강제하나

문서 규칙

  1. 한 사실은 한 곳에. 중복된 문서는 썩고, 썩은 문서는 사람과 에이전트를 적극적으로 오도한다. 다른 문서의 내용은 복사하지 말고 링크한다.
  2. 코드가 말해주는 건 쓰지 않는다. 문서에 적을 값어치가 있는 건 왜 이렇게 했는지, 왜 저건 안 했는지, 그리고 실측값(날짜와 함께)이다.
  3. 결론이 나면 DECISIONS.md 에 날짜와 함께 적고, 격리해 둔 플래그를 제거한다.
  4. 문서는 코드와 같은 커밋·같은 리뷰에서 고친다. 동작을 바꾸는 PR 이 문서를 안 고쳤으면 미완이다.